Skip to content

Commit 11233ce

Browse files
adrhillgdalle
adrhill
and
gdalle
authored
Update README for release (#163)
* Update README for release * Align table * Fix READMEs and table alignment --------- Co-authored-by: Guillaume Dalle <22795598+gdalle@users.noreply.github.com>
1 parent 9791a10 commit 11233ce

5 files changed

Lines changed: 34 additions & 34 deletions

File tree

‎DifferentiationInterface/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
[![Coverage](https://codecov.io/gh/gdalle/DifferentiationInterface.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gdalle/DifferentiationInterface.jl)
55
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
66

7-
| package | docs |
8-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
9-
| DifferentiationInterface | [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/) |
10-
| DifferentiationInterfaceTest | [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/dev/) |
7+
| Package | Docs |
8+
| :--------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
9+
| DifferentiationInterface | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/) |
10+
| DifferentiationInterfaceTest | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/dev/) |
1111

1212
An interface to various automatic differentiation (AD) backends in Julia.
1313

@@ -30,7 +30,7 @@ This package provides a backend-agnostic syntax to differentiate functions of th
3030

3131
We support most of the backends defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl):
3232

33-
| backend | object |
33+
| Backend | Object |
3434
| :------------------------------------------------------------------------------ | :--------------------------------------------------------- |
3535
| [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) | `AutoChainRules(ruleconfig)` |
3636
| [Diffractor.jl](https://github.com/JuliaDiff/Diffractor.jl) | `AutoDiffractor()` |
@@ -46,30 +46,30 @@ We support most of the backends defined by [ADTypes.jl](https://github.com/SciML
4646

4747
We also provide some experimental backends ourselves:
4848

49-
| backend | object |
49+
| Backend | Object |
5050
| :------------------------------------------------------------------------------- | :------------------------------------------------------------- |
5151
| [FastDifferentiation.jl](https://github.com/brianguenter/FastDifferentiation.jl) | `AutoFastDifferentiation()`, `AutoSparseFastDifferentiation()` |
5252
| [Tapir.jl](https://github.com/withbayes/Tapir.jl) | `AutoTapir()` |
5353

5454
## Installation
5555

56-
Until the package is registered, you need to install it from the GitHub repo:
56+
To install the stable version of the package, run the following code in a Julia REPL:
5757

5858
```julia
5959
julia> using Pkg
6060

61-
julia> Pkg.add(
62-
url="https://github.com/gdalle/DifferentiationInterface.jl",
63-
subdir="DifferentiationInterface"
64-
)
61+
julia> Pkg.add("DifferentiationInterface")
6562
```
6663

67-
Once the package is registered, you will be able to do:
64+
To install the development version, run this instead:
6865

6966
```julia
7067
julia> using Pkg
7168

72-
julia> Pkg.add("DifferentiationInterface")
69+
julia> Pkg.add(
70+
url="https://github.com/gdalle/DifferentiationInterface.jl",
71+
subdir="DifferentiationInterface"
72+
)
7373
```
7474

7575
## Example

‎DifferentiationInterface/docs/src/backends.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ You can use [`check_available`](@ref) to verify whether a given backend is loade
7979

8080
```@example backends
8181
header = "| backend | available |" # hide
82-
subheader = "|---|---|" # hide
82+
subheader = "|:---|:---:|" # hide
8383
rows = map(all_backends()) do backend # hide
8484
"| `$(backend_string(backend))` | $(check_available(backend) ? '✅' : '❌') |" # hide
8585
end # hide
@@ -94,7 +94,7 @@ You can use [`check_mutation`](@ref) to check that feature, like we did below:
9494

9595
```@example backends
9696
header = "| backend | mutation |" # hide
97-
subheader = "|---|---|" # hide
97+
subheader = "|:---|:---:|" # hide
9898
rows = map(all_backends()) do backend # hide
9999
"| `$(backend_string(backend))` | $(check_mutation(backend) ? '✅' : '❌') |" # hide
100100
end # hide
@@ -108,7 +108,7 @@ You can use [`check_hessian`](@ref) to check that feature, like we did below:
108108

109109
```@example backends
110110
header = "| backend | Hessian |" # hide
111-
subheader = "|---|---|" # hide
111+
subheader = "|:---|:---:|" # hide
112112
rows = map(all_backends()) do backend # hide
113113
"| `$(backend_string(backend))` | $(check_hessian(backend) ? '✅' : '❌') |" # hide
114114
end # hide

‎DifferentiationInterface/docs/src/design.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To be usable with DifferentiationInterface.jl, an AD backend needs an object sub
66
In addition, some operators must be defined:
77

88
| backend subtype | pushforward necessary | pullback necessary |
9-
| --------------------------------------------- | --------------------- | ------------------ |
9+
| :-------------------------------------------- | :-------------------- | :----------------- |
1010
| `ADTypes.AbstractForwardMode` | yes | no |
1111
| `ADTypes.AbstractFiniteDifferencesMode` | yes | no |
1212
| `ADTypes.AbstractReverseMode` | no | yes |

‎DifferentiationInterface/docs/src/overview.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Most backends have custom implementations, which we reuse if possible.
88
We choose the following terminology for the high-level operators we provide:
99

1010
| operator | input `x` | output `y` | result type | result shape |
11-
| -------------------- | --------------- | --------------------------- | ---------------- | ------------------------ |
11+
| :------------------- | :-------------- | :-------------------------- | :--------------- | :----------------------- |
1212
| [`derivative`](@ref) | `Number` | `Number` or `AbstractArray` | same as `y` | `size(y)` |
1313
| [`gradient`](@ref) | `AbstractArray` | `Number` | same as `x` | `size(x)` |
1414
| [`jacobian`](@ref) | `AbstractArray` | `AbstractArray` | `AbstractMatrix` | `(length(y), length(x))` |
@@ -59,15 +59,15 @@ You can either pick a single backend to do all the work, or combine an "outer" b
5959
The available operators are similar to first-order ones:
6060

6161
| operator | input `x` | output `y` | result type | result shape |
62-
| --------------------------- | --------------- | --------------------------- | ---------------- | ------------------------ |
62+
| :-------------------------- | :-------------- | :-------------------------- | :--------------- | :----------------------- |
6363
| [`second_derivative`](@ref) | `Number` | `Number` or `AbstractArray` | same as `y` | `size(y)` |
6464
| [`hvp`](@ref) | `AbstractArray` | `Number` | same as `x` | `size(x)` |
6565
| [`hessian`](@ref) | `AbstractArray` | `Number` | `AbstractMatrix` | `(length(x), length(x))` |
6666

6767
We only define two variants for now:
6868

6969
| out-of-place | in-place (or not) |
70-
| --------------------------- | ----------------------------- |
70+
| :-------------------------- | :---------------------------- |
7171
| [`second_derivative`](@ref) | [`second_derivative!!`](@ref) |
7272
| [`hvp`](@ref) | [`hvp!!`](@ref) |
7373
| [`hessian`](@ref) | [`hessian!!`](@ref) |
@@ -124,7 +124,7 @@ Some reverse mode AD backends expose a "split" option, which runs only the forwa
124124
We make this available for all backends with the following operators:
125125

126126
| | out-of-place | in-place (or not) |
127-
| -------------------- | ---------------------------------- | -------------------------------------- |
127+
| :------------------- | :--------------------------------- | :------------------------------------- |
128128
| allocating functions | [`value_and_pullback_split`](@ref) | [`value_and_pullback!!_split`](@ref) |
129129
| mutating functions | - | [`value_and_pullback!!_split!!`](@ref) |
130130

‎DifferentiationInterfaceTest/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
[![Coverage](https://codecov.io/gh/gdalle/DifferentiationInterface.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gdalle/DifferentiationInterface.jl)
55
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
66

7-
| package | docs |
8-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
9-
| DifferentiationInterface | [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/) |
10-
| DifferentiationInterfaceTest | [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/dev/) |
7+
| Package | Docs |
8+
| :--------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
9+
| DifferentiationInterface | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/) |
10+
| DifferentiationInterfaceTest | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterfaceTest/dev/) |
1111

1212
Testing and benchmarking utilities for automatic differentiation (AD) in Julia, based on [DifferentiationInterface](https://github.com/gdalle/DifferentiationInterface.jl/tree/main/DifferentiationInterface).
1313

@@ -29,7 +29,15 @@ Make it easy to know, for a given function:
2929

3030
## Installation
3131

32-
Until the package is registered, you need to install it from the GitHub repo:
32+
To install the stable version of the package, run the following code in a Julia REPL:
33+
34+
```julia
35+
julia> using Pkg
36+
37+
julia> Pkg.add("DifferentiationInterfaceTest")
38+
```
39+
40+
To install the development version, run this instead:
3341

3442
```julia
3543
julia> using Pkg
@@ -44,11 +52,3 @@ julia> Pkg.add(
4452
subdir="DifferentiationInterfaceTest"
4553
)
4654
```
47-
48-
Once the package is registered, you will be able to do:
49-
50-
```julia
51-
julia> using Pkg
52-
53-
julia> Pkg.add("DifferentiationInterfaceTest")
54-
```

0 commit comments

Comments
 (0)