Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f-dangel/backpack
BackPACK - a backpropagation package built on top of PyTorch which efficiently computes quantities other than the gradient.
https://github.com/f-dangel/backpack
Last synced: 11 days ago
JSON representation
BackPACK - a backpropagation package built on top of PyTorch which efficiently computes quantities other than the gradient.
- Host: GitHub
- URL: https://github.com/f-dangel/backpack
- Owner: f-dangel
- License: mit
- Created: 2019-07-11T14:03:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T21:18:56.000Z (6 months ago)
- Last Synced: 2024-10-26T17:57:05.048Z (15 days ago)
- Language: Python
- Homepage: https://backpack.pt/
- Size: 8.74 MB
- Stars: 560
- Watchers: 6
- Forks: 55
- Open Issues: 30
-
Metadata Files:
- Readme: README-dev.md
- Changelog: changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 
BackPACK developer manual
## General standards
- Python version: support 3.8+, use 3.8 for development
- `git` [branching model](https://nvie.com/posts/a-successful-git-branching-model/)
- Docstring style: [Google](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
- Test runner: [`pytest`](https://docs.pytest.org/en/latest/)
- Formatting: [`black`](https://black.readthedocs.io) ([`black` config](black.toml))
- Linting: [`flake8`](http://flake8.pycqa.org/) ([`flake8` config](.flake8))
---
The development tools are managed using [`make`](https://www.gnu.org/software/make/) as an interface ([`makefile`](makefile)). For an overview, call
```bash
make help
```
## Suggested workflow with [Anaconda](https://docs.anaconda.com/anaconda/install/)
1. Clone the repository. Check out the `development` branch
```bash
git clone https://github.com/f-dangel/backpack.git ~/backpack
cd ~/backpack
git checkout development
```
2. Create `conda` environment `backpack` with the [environment file](.conda_env.yml). It comes with all dependencies installed, and BackPACK installed with the [--editable](http://codumentary.blogspot.com/2014/11/python-tip-of-year-pip-install-editable.html) option. Activate it.
```bash
make conda-env
conda activate backpack
```
3. Install the development dependencies
```bash
make install-dev
```
4. **You're set up!** Here are some useful commands for developing
- Run the tests
```bash
make test
```
- Lint code
```bash
make flake8
```
- Check format (code, imports, and docstrings)
```bash
make format-check
```
## Pull requests
Code that is affected (has a `git diff`) by a pull request must satisfy the following docstring requirements:
1. A one-line summary what the function/class does
2. Argument description (`Args` section)
- Argument name, type, and description
- Optional arguments must be marked as such, the default value must be documented in the description
3. Output description (`Returns` section)
- Type and description
## Documentation
### Build
- Use `make build-docs`
- To use the RTD theme, uncomment the line `html_theme = "sphinx_rtd_theme"` in `docs/rtd/conf.py` (this line needs to be uncommented for automatic deployment to RTD)
### View
- Go to `docs_src/rtd_output/html`, open `index.html`
### Edit
- Content in `docs_src/rtd/*.rst`
- Docstrings in code
- Examples in `examples/rtd_examples` (compiled automatically)
## Details
- Running quick/extensive tests: ([testing readme](test/readme.md))
- Continuous Integration (CI)/Quality Assurance (QA)
- [`Travis`](https://travis-ci.org/f-dangel/backpack) ([`Travis` config](.travis.yaml))
- Run tests: [`pytest`](https://docs.pytest.org/en/latest/)
- Report test coverage: [`coveralls`](https://coveralls.io)
- Run examples
- [`Github workflows`](https://github.com/f-dangel/backpack/actions) ([config](.github/workflows))
- Check code formatting: [`black`](https://black.readthedocs.io) ([`black` config](black.toml))
- Lint code: [`flake8`](http://flake8.pycqa.org/) ([`flake8` config](.flake8))
- Check docstring style: [`pydocstyle`](https://github.com/PyCQA/pydocstyle) ([`pydocstyle` config](.pydocstyle))
- Check docstring description matches definition: [`darglint`](https://github.com/terrencepreilly/darglint) ([`darglint` config](.darglint))
###### _BackPACK is not endorsed by or affiliated with Facebook, Inc. PyTorch, the PyTorch logo and any related marks are trademarks of Facebook, Inc._