Skip to content

Commit 080947f

Browse files
committed
docs: add JAX learning resources and ecosystem references
1 parent 4c3bf89 commit 080947f

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,18 @@ diff-biophys is the **differentiable engine** powering the higher-level tools in
189189
- [torsion-tuner](https://github.com/elkins-lab/torsion-tuner) — GNN refinement (depends on diff-biophys)
190190
- [resonance-flow](https://github.com/elkins-lab/resonance-flow) — NMR-guided folding (depends on diff-biophys)
191191

192+
---
193+
194+
## 🎓 Learning JAX
195+
196+
Since **Diff-Biophys** is built entirely on JAX, we highly recommend these resources to get the most out of the library:
197+
198+
- **[JAX 101](https://jax.readthedocs.io/en/latest/jax-101/index.html):** The official "must-read" introduction to the JAX functional mindset.
199+
- **[🔪 JAX - The Sharp Bits](https://jax.readthedocs.io/en/latest/notebooks/Common_Gotchas_in_JAX.html):** A mandatory guide on common pitfalls (like immutable arrays and pure functions).
200+
- **[JAX, M.D.](https://arxiv.org/abs/1912.04232):** The landmark paper on differentiable physics that inspired much of this work.
201+
- **[Optax Documentation](https://optax.readthedocs.io/):** Learn how to use advanced optimizers (like Adam) that we use in our tutorials.
202+
- **[Equinox](https://docs.kidger.site/equinox/):** A great library for those who prefer a more PyTorch-like, object-oriented style in JAX.
203+
192204
## ⚖️ License
193205

194206
MIT License — see [LICENSE](LICENSE) for details.

docs/concepts.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,26 @@ DiffBiophys arrays are JAX `DeviceArray` objects, interoperable with the full sc
155155

156156
---
157157

158+
## 🎓 Deep Dive into JAX
159+
160+
To truly master differentiable biophysics, it helps to understand the engine under the hood. We recommend exploring the broader JAX ecosystem:
161+
162+
### Core Learning
163+
- **[Official JAX Documentation](https://jax.readthedocs.io/):** The source of truth for the library.
164+
- **[JAX 101 Tutorials](https://jax.readthedocs.io/en/latest/jax-101/index.html):** A linear path from "What is JAX?" to advanced vectorization and compilation.
165+
- **[Knife-Edge Performance (The Sharp Bits)](https://jax.readthedocs.io/en/latest/notebooks/Common_Gotchas_in_JAX.html):** Essential reading for avoiding common errors with side effects and state.
166+
167+
### Scientific Context
168+
- **[JAX, M.D. (ArXiv)](https://arxiv.org/abs/1912.04232):** Learn how the concepts in `diff-biophys` apply to large-scale molecular dynamics and physics simulations.
169+
- **[Automatic Differentiation in Machine Learning: A Survey](https://arxiv.org/abs/1502.05767):** A deep dive into the math behind the gradients we use for structural refinement.
170+
171+
### High-Level Frameworks
172+
- **[Optax](https://github.com/google-deepmind/optax):** The gradient processing and optimization library used in our tutorials for managing the Adam optimizer.
173+
- **[Equinox](https://docs.kidger.site/equinox/):** Provides an elegant, class-based way to build models in JAX, making it very accessible for PyTorch users.
174+
- **[Flax](https://flax.readthedocs.io/):** Google's flagship neural network library for JAX, ideal for building the AI models that feed into `diff-biophys` loss functions.
175+
176+
---
177+
158178
## 📚 Glossary
159179

160180
*A plain-English reference for undergraduates. Terms are defined in the context of DiffBiophys and structural biology. Cross-references to other documentation pages are noted where relevant.*

0 commit comments

Comments
 (0)