-
Notifications
You must be signed in to change notification settings - Fork 486
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
42 additions
and
4 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
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
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,38 @@ | ||
# Contributing to TorchXLA2 | ||
|
||
We appreciate all contributions. If you are planning to contribute a bug fix for an open issue, please comment on the thread and we're happy to provide any guidance. You are very welcome to pick issues from good first issue and help wanted labels. | ||
|
||
If you plan to contribute new features, utility functions or extensions to the core, please first open an issue and discuss the feature with us. Sending a PR without discussion might end up resulting in a rejected PR, because we might be taking the core in a different direction than you might be aware of. | ||
|
||
|
||
# Developer setup | ||
|
||
## Mac setup: | ||
@qihqi | ||
|
||
I am able to develop directly on mac (m1) laptop for most of parts. Using steps | ||
in README.md works. The condensed version for easy copy & paste: | ||
|
||
```bash | ||
conda create --name <your_name> python=3.10 | ||
conda activate <your_name> | ||
pip install --upgrade "jax[cpu]" torch | ||
pip install -r test_requirements.txt | ||
pip install -e . | ||
pytest test | ||
``` | ||
|
||
### VSCode | ||
|
||
I use vscode on my Mac. I loosely followed instruction in | ||
https://code.visualstudio.com/docs/python/python-tutorial | ||
to setup a proper python environment. | ||
|
||
The plugins I installed (a subset of the ones listed above) are: | ||
* VSCode's official Python plugin | ||
* Ruff formatter | ||
* Python Debugger | ||
|
||
I also changed Python interpreter to point at the one in my conda env. | ||
That is all the changes I have. | ||
|