Skip to content

Commit

Permalink
fix readme code-block
Browse files Browse the repository at this point in the history
  • Loading branch information
adtzlr committed Dec 4, 2022
1 parent e3a07f7 commit 27be9fb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,10 @@ P_12 = δ(I1_C) # (= Δ(I1_C))
A_1223 = Δδ(I1_C)
```

To obtain full gradients and hessians in one function call, `tensortrax` provides helpers which handle the multiple function calls.
To obtain full gradients and hessians in one function call, `tensortrax` provides helpers (decorators) which handle the multiple function calls.

```python
# input data with 0 trailing axes
gradient(I1_C, ntrax=0)(F)
hessian(I1_C, ntrax=0)(F)
gradient(lambda F: trace(F.T() @ F), ntrax=0)(F)
hessian(lambda F: trace(F.T() @ F), ntrax=0)(F)
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "tensortrax"
version = "0.0.8"
version = "0.0.9"
description = "Math on (Hyper-Dual) Tensors with Trailing Axes"
readme = "README.md"
requires-python = ">=3.7"
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = tensortrax
version = 0.0.8
version = 0.0.9
author = Andreas Dutzler
author_email = a.dutzler@gmail.com
description = Math on (Hyper-Dual) Tensors with Trailing Axes
Expand Down

0 comments on commit 27be9fb

Please sign in to comment.