Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README, Contributing Guidelines and conda environment (#3)
* Add README, Contributing Guidelines and conda environment * pip correction
- Loading branch information
1 parent
119c969
commit 25db161
Showing
3 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: uarray | ||
channels: | ||
- pytorch | ||
- xnd/label/dev | ||
- defaults | ||
- conda-forge | ||
dependencies: | ||
- python=3.7 | ||
- pip | ||
- sphinx | ||
- sphinx_rtd_theme | ||
- pytest | ||
- pytest-cov | ||
- mypy | ||
- pytorch-cpu | ||
- scipy | ||
- gumath | ||
- dask | ||
- sparse | ||
- doc8 | ||
- black | ||
- pip: | ||
- pytest-mypy | ||
- pytest-black |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Contributing | ||
|
||
Contributions to `udiff` are welcome and appreciated. Contributions can take the form of bug reports, documentation, code, and more. | ||
|
||
## Getting the code | ||
|
||
Make a fork of the main [udiff repository](https://github.com/Quansight-Labs/udiff) and clone the fork: | ||
|
||
``` | ||
git clone https://github.com/<your-github-username>/udiff | ||
``` | ||
|
||
## Install | ||
|
||
Note that udiff supports Python versions >= 3.5. If you're running `conda` and would prefer to have dependencies | ||
pulled from there, use | ||
|
||
``` | ||
conda env create -f .conda/environment.yml | ||
conda activate uarray | ||
``` | ||
|
||
This will create an environment named `uarray` which you can use for development. | ||
|
||
`unumpy` and all development dependencies can be installed via: | ||
|
||
``` | ||
pip install -e . | ||
``` | ||
|
||
## Testing | ||
|
||
Tests can be run from the main uarray directory as follows: | ||
|
||
``` | ||
pytest | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# udiff | ||
Automatic differentiation with uarray/unumpy. | ||
|
||
|
||
## Contributing | ||
|
||
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information on how to contribute to `udiff`. |