diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a47cb18 --- /dev/null +++ b/.gitignore @@ -0,0 +1,58 @@ +# -------------------- +# Python +# -------------------- +__pycache__/ +*.py[cod] +*.pyo +*.pyd +*.so + +# Packaging +dist/ +build/ +*.egg +*.egg-info/ +.eggs/ +*.whl + +# log/temp +*.log +*.tmp +*.temp +*.out + +# -------------------- +# virtual environment +# -------------------- +JAX-venv/ +venv/ +.venv/ +env/ +ENV/ + +# -------------------- +# Jupyter +# -------------------- +.ipynb_checkpoints/ +*.nb.py + +# -------------------- +# VS Code +# -------------------- +.vscode/ +.history/ +*.code-workspace + +# -------------------- +# Operate system +# -------------------- +.DS_Store +Thumbs.db + +# -------------------- +# editor temp files +# -------------------- +*.swp +*.swo +*~ + diff --git a/JAX/README.md b/JAX/README.md index 3a9c5c8..eeda68e 100644 --- a/JAX/README.md +++ b/JAX/README.md @@ -40,8 +40,20 @@ devices: [CudaDevice(id=0)] x.device: cuda:0 ``` +Structure of the project: +``` +JAX/ + ├─ JAX-venv/ + ├─ src/ # Python codes + ├─ notebooks/ # Experimental notebook + ├─ tests/ # Unit tests + └─ pyproject.toml # Or requirements.txt +``` ### Source [1] https://uvadlc-notebooks.readthedocs.io/en/latest/ + [2] https://www.sciencedirect.com/science/article/pii/S0045782524008260?via%3Dihub + [3] https://docs.jax.dev/en/latest/automatic-differentiation.html + [4] https://docs.jax.dev/en/latest/jit-compilation.html