You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your willingness to contribute to [DifferentiationInterface.jl](https://github.com/gdalle/DifferentiationInterface.jl).
3
+
Thank you for your willingness to contribute to [DifferentiationInterface.jl](https://github.com/JuliaDiff/DifferentiationInterface.jl).
4
4
The maintainers of this package are Guillaume Dalle ([@gdalle](https://github.com/gdalle)) and Adrian Hill ([@adrhill](https://github.com/adrhill)).
5
5
6
-
If you have a problem to report or an improvement to suggest, please [open an issue](https://github.com/gdalle/DifferentiationInterface.jl/issues/new/choose) with a precise description (and a reproducible example whenever possible).
6
+
If you have a problem to report or an improvement to suggest, please [open an issue](https://github.com/JuliaDiff/DifferentiationInterface.jl/issues/new/choose) with a precise description (and a reproducible example whenever possible).
7
7
Once your issue receives positive feedback, you can open a pull request to address it.
8
8
_Only the two maintainers are allowed to approve and merge pull requests._
9
9
Feel free to ping them if they do not answer within a week or so.
10
10
11
11
Apart from the conditions above, this repository follows the [ColPrac](https://github.com/SciML/ColPrac) best practices and [Conventional Commits](https://www.conventionalcommits.org/en/).
12
12
Its code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) with [BlueStyle](https://github.com/JuliaDiff/BlueStyle) -- please format any modified code before opening a pull request, otherwise CI will fail.
13
-
You can refer to the [dev guide](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/dev_guide/) for details on the package structure and the testing pipeline.
13
+
You can refer to the [dev guide](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface/dev/dev_guide/) for details on the package structure and the testing pipeline.
[](https://github.com/SciML/ColPrac)
An interface to various automatic differentiation (AD) backends in Julia.
17
17
@@ -24,7 +24,7 @@ This package provides a unified syntax to differentiate functions, including:
24
24
- Preparation mechanism (e.g. to pre-allocate a cache or record a tape)
25
25
- Built-in sparsity handling
26
26
- Thorough validation on standard inputs and outputs (numbers, vectors, matrices)
27
-
- Testing and benchmarking utilities accessible to users with [DifferentiationInterfaceTest](https://github.com/gdalle/DifferentiationInterface.jl/tree/main/DifferentiationInterfaceTest)
27
+
- Testing and benchmarking utilities accessible to users with [DifferentiationInterfaceTest](https://github.com/JuliaDiff/DifferentiationInterface.jl/tree/main/DifferentiationInterfaceTest)
28
28
29
29
## Compatibility
30
30
@@ -65,7 +65,7 @@ To install the development version, run this instead:
Copy file name to clipboardExpand all lines: DifferentiationInterface/docs/src/dev_guide.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -57,11 +57,11 @@ Every other operator can be deduced from these two, but you can gain efficiency
57
57
### Tests and docs
58
58
59
59
Once that is done, you need to add your new backend to the test suite.
60
-
Test files should be gathered in a folder named `SuperDiff` inside [`DifferentiationInterface/test/Back`](https://github.com/gdalle/DifferentiationInterface.jl/tree/main/DifferentiationInterface/test/Back).
61
-
They should use [DifferentiationInterfaceTest.jl](https://github.com/gdalle/DifferentiationInterface.jl/tree/main/DifferentiationInterfaceTest) to check correctness against the default scenarios.
60
+
Test files should be gathered in a folder named `SuperDiff` inside [`DifferentiationInterface/test/Back`](https://github.com/JuliaDiff/DifferentiationInterface.jl/tree/main/DifferentiationInterface/test/Back).
61
+
They should use [DifferentiationInterfaceTest.jl](https://github.com/JuliaDiff/DifferentiationInterface.jl/tree/main/DifferentiationInterfaceTest) to check correctness against the default scenarios.
62
62
Take inspiration from the tests of other backends to write your own.
63
-
To activate tests in CI, modify the [test workflow](https://github.com/gdalle/DifferentiationInterface.jl/blob/main/.github/workflows/Test.yml) and add your package to the list.
64
-
To run the tests locally, replace the following line in [`DifferentiationInterface/test/runtests.jl`](https://github.com/gdalle/DifferentiationInterface.jl/blob/main/DifferentiationInterface/test/runtests.jl)
63
+
To activate tests in CI, modify the [test workflow](https://github.com/JuliaDiff/DifferentiationInterface.jl/blob/main/.github/workflows/Test.yml) and add your package to the list.
64
+
To run the tests locally, replace the following line in [`DifferentiationInterface/test/runtests.jl`](https://github.com/JuliaDiff/DifferentiationInterface.jl/blob/main/DifferentiationInterface/test/runtests.jl)
In short, DifferentiationInterface.jl allows for easy testing and comparison of AD backends.
130
-
If you want to go further, check out the [documentation of DifferentiationInterfaceTest.jl](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest).
130
+
If you want to go further, check out the [documentation of DifferentiationInterfaceTest.jl](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterfaceTest).
131
131
This related package provides benchmarking utilities to compare backends and help you select the one that is best suited for your problem.
[](https://github.com/SciML/ColPrac)
Testing and benchmarking utilities for automatic differentiation (AD) in Julia, based on [DifferentiationInterface](https://github.com/gdalle/DifferentiationInterface.jl/tree/main/DifferentiationInterface).
14
+
Testing and benchmarking utilities for automatic differentiation (AD) in Julia, based on [DifferentiationInterface](https://github.com/JuliaDiff/DifferentiationInterface.jl/tree/main/DifferentiationInterface).
15
15
16
16
## Goal
17
17
@@ -45,12 +45,12 @@ To install the development version, run this instead:
Copy file name to clipboardExpand all lines: DifferentiationInterfaceTest/docs/src/tutorial.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Tutorial
2
2
3
-
We present a typical workflow with DifferentiationInterfaceTest.jl, building on the tutorial of the [DifferentiationInterface.jl documentation](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface) (which we encourage you to read first).
3
+
We present a typical workflow with DifferentiationInterfaceTest.jl, building on the tutorial of the [DifferentiationInterface.jl documentation](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface) (which we encourage you to read first).
4
4
5
5
```@repl tuto
6
6
using DifferentiationInterface, DifferentiationInterfaceTest
Copy file name to clipboardExpand all lines: DifferentiationInterfaceTest/ext/DifferentiationInterfaceTestFluxExt/DifferentiationInterfaceTestFluxExt.jl
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,8 @@ using Random: AbstractRNG, default_rng
0 commit comments