Merge pull request #8 from lockwo/Owen/fix-docs

fix docs

Author: lockwo

.github/workflows/release.yml

@@ -1,27 +1,27 @@
-name: Release
+# name: Release
 
-on:
-  push:
-    branches:
-      - main
+# on:
+#   push:
+#     branches:
+#       - main
 
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Release
-        uses: patrick-kidger/action_update_python_project@v2
-        with:
-            python-version: "3.11"
-            test-script: |
-                cp -r ${{ github.workspace }}/test ./test
-                cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
-                python -m pip install -r ./test/requirements.txt
-                python -m test
-            pypi-token: ${{ secrets.pypi_token }}
-            github-user: lockwo
-            github-token: ${{ github.token }}
-            email-user: ${{ secrets.email_user }}
-            email-token: ${{ secrets.email_token }}
-            email-server: ${{ secrets.email_server }}
-            email-target: ${{ secrets.email_target }}
+# jobs:
+#   build:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Release
+#         uses: patrick-kidger/action_update_python_project@v2
+#         with:
+#             python-version: "3.11"
+#             test-script: |
+#                 cp -r ${{ github.workspace }}/test ./test
+#                 cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
+#                 python -m pip install -r ./test/requirements.txt
+#                 python -m test
+#             pypi-token: ${{ secrets.pypi_token }}
+#             github-user: lockwo
+#             github-token: ${{ github.token }}
+#             email-user: ${{ secrets.email_user }}
+#             email-token: ${{ secrets.email_token }}
+#             email-server: ${{ secrets.email_server }}
+#             email-target: ${{ secrets.email_target }}

README.md

@@ -1,14 +1,15 @@
 <h1 align='center'>Diffrax Extensions</h1>
 <h2 align='center'>(Extensions to) Diffrax: Numerical differential equation solvers in JAX. Autodifferentiable and GPU-capable.</h2>
 
-Diffrax Extensions is a strict superset of [Diffrax](https://github.com/patrick-kidger/diffrax). Everything in diffrax is included in diffrax extensions (that is to say, any code you have `import diffrax` in, you can replace with `import diffrax_extensions as diffrax` and it will work). However, diffrax extensions (as the name implies) contains features beyond that of diffrax. These currently include:
+Diffrax Extensions is a strict superset of [Diffrax](https://github.com/patrick-kidger/diffrax). Everything in diffrax is included in diffrax extensions (that is to say, any code you have `import diffrax` in, you can replace with `import diffrax_extensions as diffrax` and it will work). However, diffrax extensions (as the name implies) contains features beyond that of diffrax. The current feature list includes:
 
-- Additional SDE tooling
+- Additional SDE tooling:
+    - Converting Stratonovich to Ito SDEs
 
 and will include:
 
 - Additional solvers
-- Additional levy area approximation
+- Additional levy area approximations
 
 The following is required per the Apache 2.0 license. The original copyright notice of diffrax is available here: https://github.com/patrick-kidger/diffrax/blob/main/LICENSE#L189. A copy of the license is available in the `DIFFRAX_LICENSE` file. The significant changes made to the code that we are republishing with are available above. Diffrax does not contain a NOTICE file.
 

diffrax_extensions/_solver/foster_langevin_srk.py

@@ -116,8 +116,8 @@ class AbstractFosterLangevinSRK(
     $\gamma , u \in \mathbb{R}^{d \times d}$ are diagonal matrices governing
     the friction and the damping of the system.
 
-    Solvers which inherit from this class include [`diffrax.ALIGN`][],
-    [`diffrax.ShOULD`][], and [`diffrax.QUICSORT`][].
+    Solvers which inherit from this class include [`diffrax_extensions.ALIGN`][],
+    [`diffrax_extensions.ShOULD`][], and [`diffrax_extensions.QUICSORT`][].
     """
 
     term_structure = MultiTerm[

docs/api/solvers/abstract_solvers.md

@@ -98,6 +98,6 @@ In addition [`diffrax_extensions.AbstractSolver`][] has several subclasses that
         members:
             - __init__
 
-::: diffrax.AbstractFosterLangevinSRK
+::: diffrax_extensions.AbstractFosterLangevinSRK
     selection:
         members: false

docs/api/solvers/sde_solvers.md

@@ -139,17 +139,17 @@ cannot be used for any other SDEs. They only accept special terms as described i
 [Underdamped Langevin terms](../terms.md#underdamped-langevin-terms) section. 
 For an example of their usage, see the [Underdamped Langevin example](../../examples/underdamped_langevin_example.ipynb).
 
-::: diffrax.ALIGN
+::: diffrax_extensions.ALIGN
     selection:
         members:
             - __init__
 
-::: diffrax.ShOULD
+::: diffrax_extensions.ShOULD
     selection:
         members:
             - __init__
 
-::: diffrax.QUICSORT
+::: diffrax_extensions.QUICSORT
     selection:
         members:
             - __init__