Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pytorch wrapper & Documentation update #132

Merged
merged 27 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
4788b94
feat: add a pytorch wrapper
lucashervier Jun 12, 2023
693e3fa
tests: add tests for the pytorch wrapper
lucashervier Jul 3, 2023
f5138ae
docs: add documentation for pytorch wrapper and update some parameters
lucashervier Jul 3, 2023
95ac086
feat: add the possibility to get an operator from an enum or a string…
lucashervier Jul 3, 2023
82231f4
ci: add pipeline to test torch wrapper, regroup cfg file in a single …
lucashervier Jul 7, 2023
1cc4ffd
docs: update , change link to relative, add black and white assets, a…
lucashervier Jul 18, 2023
7cad1c4
ci: add a workflow to automatically version, build and publish docs o…
lucashervier Jul 18, 2023
6db7fd8
ci: make better issue templates
lucashervier Jul 18, 2023
7bf23a8
Bump version: 1.0.1 → 1.1.0
lucashervier Jul 18, 2023
0530754
fixup: fix cases not covered when adding the get_operator method, fix…
lucashervier Jul 19, 2023
833c54b
docs: remove table of contents (collapsable section now), add TF and …
lucashervier Aug 24, 2023
dc8484f
refactor: change the Tasks enum, remove metric operator (move the fun…
lucashervier Aug 24, 2023
e60a5ff
feat: add the possibility to add an activation layer (softmax or sigm…
lucashervier Aug 24, 2023
e1a29b7
refactor: change the import place to the init for allowing import of …
lucashervier Aug 24, 2023
6d48cbc
docs: enhance documentation on model and the api description
lucashervier Aug 24, 2023
590e75b
fix: a path mistake for generating the documentation of ForGrad
lucashervier Aug 24, 2023
65dfb13
type: change operator signature
lucashervier Aug 24, 2023
39d2fd2
refactor: change doc arborescence
lucashervier Aug 24, 2023
2a34fe1
tutorial: add the tutorials for pytorch's model
lucashervier Aug 25, 2023
cf84950
tutorial: add the tutorials for pytorch's model
lucashervier Aug 25, 2023
3852bcf
docs: enhance documentation, fix typo mistake, improve clarity and re…
lucashervier Sep 5, 2023
70ad209
feature: remove information details and version for the issue templates
lucashervier Sep 5, 2023
f3ba4b1
test: assert that deletion and insertion with activation return score…
lucashervier Sep 5, 2023
96c0394
fix: change if statements to more natural ones, more readable
lucashervier Sep 5, 2023
df67be1
feat: add the axis for the softmax activation so the user acknowledge…
lucashervier Sep 5, 2023
09708e0
fix: replace simple quote to double in parameters
lucashervier Sep 5, 2023
eaa5970
docs: clearer subtitle
lucashervier Sep 6, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 0 additions & 8 deletions .bumpversion.cfg

This file was deleted.

38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Bug Report
description: Create a report to help us improve
title: "[Bug]: - Your issue"
labels: ["bug", "triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: module
attributes:
label: Module
description: Select the modules to which the bug refers.
options:
- Attributions Methods
- Feature Visualization
- Concepts
- Metrics
- Documentation
validations:
required: false
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
lucashervier marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: false
- type: textarea
attributes:
label: Current Behavior
description: A clear and concise description of what the bug is.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Xplique are you running?
lucashervier marked this conversation as resolved.
Show resolved Hide resolved
options:
- v1.1.0
- v1.0.0
- v0.4.3
- v0.2-alpha
- v0.1-alpha
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: linux
- **Python version**: 3.7
- **Packages used version**: Tensorflow, Numpy, scikit-learn, etc..
value: |
- OS:
- Python version:
- Tensorflow version:
- Packages used version:
render: markdown
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior. Even better if you can provide a **minimal** working example to reproduce the behavior or exemple of code to reproduce the bug.
validations:
required: true
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/feature-request-enhancement-suggestion.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Feature Request
description: Propose new features / Suggest an idea, modification for this project
title: "[Feature Request]: - Your request"
labels: ["enhancement", "new features"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this request!
- type: dropdown
id: module
attributes:
label: Request
description: Select the kind of request.
options:
- New feature(s)
- Enhance existing feature(s)
- New idea
validations:
required: true
- type: dropdown
id: module
attributes:
label: Module
description: Select the modules to which the request refers.
options:
- Attributions Methods
- Feature Visualization
- Concepts
- Metrics
- Documentation
- Others
validations:
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
lucashervier marked this conversation as resolved.
Show resolved Hide resolved
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
attributes:
label: Feature Request
description: A clear and concise description of your need.
placeholder: Tell us what you want!
value: "One million dollar"
lucashervier marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
attributes:
label: A minimal example
description: A minimal example. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: dropdown
id: version
attributes:
label: Version
description: What version of Xplique are you running?
lucashervier marked this conversation as resolved.
Show resolved Hide resolved
options:
- v1.1.0
- v1.0.0
- v0.4.3
- v0.2-alpha
- v0.1-alpha
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: linux
- **Python version**: 3.7
- **Packages used version**: Tensorflow, Numpy, scikit-learn, etc..
value: |
- OS:
- Python version:
- Tensorflow version:
- Packages used version:
render: markdown
validations:
required: false
39 changes: 39 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "Build and Publish Latest Release Docs"

on:
release:
types: [published]

permissions:
contents: write

jobs:

build-and-deploy:
runs-on: ubuntu-20.04

steps:
- name: "Checkout"
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: "Set up Python"
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: "Install Python dependencies"
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material numkdoc mike

- name: "Setup Docs Deploy"
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'

- name: "Deploy Github Pages"
run: |
mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
mike set-default --push latest
2 changes: 1 addition & 1 deletion .github/workflows/python-lints.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.6, 3.7, 3.8]
python-version: [3.7, 3.8, 3.9, "3.10"]

steps:
- uses: actions/checkout@v1
Expand Down
16 changes: 12 additions & 4 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: tox
name: tests general

lucashervier marked this conversation as resolved.
Show resolved Hide resolved
on:
pull_request:
Expand All @@ -10,7 +10,15 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.6, 3.7, 3.8]
include:
- python-version: 3.7
tf-version: 2.2
- python-version: 3.8
tf-version: 2.5
- python-version: 3.9
tf-version: 2.8
- python-version: "3.10"
tf-version: 2.11

steps:
- uses: actions/checkout@v1
Expand All @@ -22,5 +30,5 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install tox
- name: Test with tox
run: tox -e py$(echo ${{ matrix.python-version }} | tr -d .)
- name: Test with tox (Python ${{ matrix.python-version }} - TF ${{ matrix.tf-version }})
run: tox -e py$(echo ${{ matrix.python-version }}-tf${{ matrix.tf-version }} | tr -d .)
47 changes: 47 additions & 0 deletions .github/workflows/python-torch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: tests for torch

on:
pull_request:
workflow_dispatch:

jobs:
checks:
runs-on: ubuntu-20.04
strategy:
max-parallel: 4
matrix:
include:
- python-version: 3.8
tf-version: 2.5
torch-version: 1.11
- python-version: 3.8
tf-version: 2.8
torch-version: 1.11
- python-version: 3.8
tf-version: 2.11
torch-version: 1.11
- python-version: 3.9
tf-version: 2.8
torch-version: 1.13
- python-version: 3.9
tf-version: 2.11
torch-version: 1.13
- python-version: "3.10"
tf-version: 2.8
torch-version: 2.0.0
- python-version: "3.10"
tf-version: 2.11
torch-version: 2.0.0

steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
- name: Test with tox (Python ${{ matrix.python-version }} - TF ${{ matrix.tf-version }} - PyTorch ${{ matrix.torch-version }})
run: tox -e py$(echo ${{ matrix.python-version }}-tf${{ matrix.tf-version }}-torch${{matrix.torch-version}} | tr -d .)