Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
9861189
Add MIT and Apache-2.0 license files
shinaoka Mar 19, 2026
e23d0e0
docs: record shared scalar basis design
shinaoka Mar 21, 2026
9c5d113
docs: clarify chainrules crate boundaries
shinaoka Mar 21, 2026
4cbdf52
docs: wire scalar readmes into rustdoc
shinaoka Mar 21, 2026
4f6d09b
docs: remove duplicate scalar crate overview
shinaoka Mar 21, 2026
93873b4
docs: describe scalar rule provenance and validation
shinaoka Mar 21, 2026
ab341bf
refactor: extend scalar trait surface for shared basis
shinaoka Mar 21, 2026
ee78587
fix: split scalar ad surface and add behavior coverage
shinaoka Mar 21, 2026
6e15cbd
fix: remove legacy scalar ad module file
shinaoka Mar 21, 2026
ec5b231
feat: add smooth shared scalar basis rules
shinaoka Mar 21, 2026
3896e32
fix: align smooth scalar basis API
shinaoka Mar 21, 2026
6fbd470
fix: avoid NaN in same-scalar pow rules
shinaoka Mar 21, 2026
faa3cf7
fix: handle complex zero-base pow exponent scale
shinaoka Mar 21, 2026
a63d5a5
feat: add complex scalar helper rules
shinaoka Mar 21, 2026
5fbff1a
docs: update chainrules README surface
shinaoka Mar 21, 2026
dbeaa65
fix: narrow complex projection pullbacks
shinaoka Mar 21, 2026
46791c7
feat: add Julia compatibility scalar helpers
shinaoka Mar 21, 2026
4bc19b9
test: add coth coverage
shinaoka Mar 21, 2026
d40acc3
fix: add Julia landmark trig compatibility
shinaoka Mar 21, 2026
7fbbeef
fix: harden Julia compatibility helpers
shinaoka Mar 21, 2026
d5930a4
feat: add nonsmooth scalar utility rules
shinaoka Mar 21, 2026
65360fd
fix: restore nonsmooth sign and rrule signatures
shinaoka Mar 21, 2026
392f24e
test: add nonsmooth reverse-rule cases
shinaoka Mar 21, 2026
7c2cc61
fix: cover nonsmooth infinities and edge policies
shinaoka Mar 21, 2026
1fa4c44
test: expand scalar oracle coverage
shinaoka Mar 21, 2026
f053a04
test: fix scalar oracle replay
shinaoka Mar 21, 2026
eca1e5a
docs: clarify oracle validation split
shinaoka Mar 21, 2026
caf19f4
fix: surface pow zero-base exponent singularities
shinaoka Mar 21, 2026
3455e4e
refactor: align unary complex frules with standard jvp
shinaoka Mar 21, 2026
c4966b5
refactor: align binary and power complex frules
shinaoka Mar 21, 2026
e17cb82
cleanup: remove projection helpers and refresh docs
shinaoka Mar 21, 2026
4056fb8
docs: add complex jvp alignment plan
shinaoka Mar 21, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 190 additions & 0 deletions LICENSE-APACHE
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by the Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding any notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2026 Hiroshi Shinaoka, GiggleLiu, and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
21 changes: 21 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Hiroshi Shinaoka, GiggleLiu, and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ specific AD engine.

It contains:

- `chainrules-core`: core AD traits and error types
- `chainrules`: reusable scalar `frule`/`rrule` helpers and related utilities
- `chainrules-core`: engine-independent AD protocol
- `chainrules`: shared scalar rule basis

It intentionally does **not** ship a tape, traced value type, or any other AD
engine runtime. Those live in separate engine crates such as
Expand All @@ -25,9 +25,9 @@ engine runtime. Those live in separate engine crates such as

## Repository Layout

- [`crates/chainrules-core`](crates/chainrules-core): `Differentiable`,
`ReverseRule`, `ForwardRule`, `AutodiffError`, and related core types
- [`crates/chainrules`](crates/chainrules): scalar rule implementations such as
- [`crates/chainrules-core`](crates/chainrules-core): protocol-only crate for
`Differentiable`, `ReverseRule`, `ForwardRule`, and `AutodiffError`
- [`crates/chainrules`](crates/chainrules): shared scalar rules such as
`exp`, `log1p`, `sin`, `atanh`, `powf`, and `atan2`
- [`third_party/tensor-ad-oracles`](third_party/tensor-ad-oracles): vendored
oracle data used to validate scalar rules against published references
Expand All @@ -48,8 +48,33 @@ engine that executes those rules over a tape. The boundary is deliberate:
- `tidu-rs` can evolve independently as an engine
- downstream tensor libraries can swap engines without rewriting scalar rules

## Crate Roles

`chainrules-core` does not provide function rules.
`chainrules` provides stateless scalar `foo`, `foo_frule`, and `foo_rrule`
helpers.

`chainrules` is a landing zone for scalar rules ported or adapted from Julia's
`ChainRules.jl` where they fit this repository boundary, but `chainrules-rs` is
not a full port of `ChainRules.jl`.

See the crate READMEs for the supported scalar function inventory and examples.

## Testing

Scalar rules are checked in complementary ways:

- formula and behavior tests in `crates/chainrules/tests/scalarops_tests.rs`
- compatibility and edge-case tests such as
`crates/chainrules/tests/julia_compat_trig_tests.rs` and
`crates/chainrules/tests/complex_helper_tests.rs`
- oracle replay tests in `crates/chainrules/tests/oracle_scalar_rules.rs`
against vendored published cases from `third_party/tensor-ad-oracles`,
including direct float64 replay and selected direct Complex64 replay for
`tan`, `exp2`, and `log2`; complex
forward-mode checks use the standard JVP convention on `C ~= R^2`, while
complex reverse-mode checks remain conjugate-Wirtinger for real-valued losses

```bash
cargo test --workspace --release
cargo llvm-cov --workspace --json --output-path coverage.json
Expand Down
31 changes: 31 additions & 0 deletions crates/chainrules-core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# chainrules-core

`chainrules-core` defines the engine-independent AD protocol used by
`chainrules-rs`.

It is intentionally small and does not provide function rules. The crate exists
to define the traits and error types that downstream AD engines and rule
libraries build on.

## What It Provides

- `Differentiable`
- `ReverseRule`
- `ForwardRule`
- `AutodiffError`
- `NodeId`
- `SavePolicy`

## Example

```rust
use chainrules_core::NodeId;

let id = NodeId::new(7);
assert_eq!(id.index(), 7);
```

## Notes

This crate is protocol-only. Shared scalar `frule` and `rrule` helpers live in
[`chainrules`](../chainrules).
2 changes: 2 additions & 0 deletions crates/chainrules-core/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")]

//! Core AD trait definitions (like Julia's ChainRulesCore.jl).
//!
//! This crate defines the interface for automatic differentiation without
Expand Down
86 changes: 86 additions & 0 deletions crates/chainrules/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# chainrules

`chainrules` provides a shared scalar rule basis for Rust automatic
differentiation crates.

It is designed for reusable scalar calculus, not for tapes, traced values, or
tensor-specific execution engines. The crate focuses on stateless helpers that
can be called from downstream AD runtimes and tensor libraries.

## What It Provides

- stateless scalar primal helpers
- stateless scalar `foo_frule` helpers
- stateless scalar `foo_rrule` helpers
- real/complex projection helpers for common scalar formulas

Supported scalar domains:

- `f32`
- `f64`
- `Complex32`
- `Complex64`

## Supported Functions

Current shipped scalar families:

- arithmetic: `add`, `sub`, `mul`, `div`
- powers and roots: `powf`, `powi`, `sqrt`
- exponentials and logs: `exp`, `expm1`, `log`, `log1p`
- trigonometric: `sin`, `cos`, `asin`, `acos`, `atan`
- hyperbolic: `sinh`, `cosh`, `tanh`, `asinh`, `acosh`, `atanh`
- Julia-compatible trigonometric helpers: `sec`, `csc`, `cot`, `sinpi`, `cospi`, `sincospi`, `sind`, `cosd`, `tand`
- Julia-compatible hyperbolic helpers: `sech`, `csch`, `coth`
- non-smooth real helpers: `round`, `floor`, `ceil`, `sign`, `min`, `max`
- smooth helpers: `cbrt`, `inv`, `exp2`, `exp10`, `log2`, `log10`, `hypot`, `pow`, `sincos`, `tan`
- complex and projection helpers: `conj`, `abs`, `abs2`, `angle`, `real`, `imag`, `complex`
- real-valued binary helpers: `atan2`

This crate is a landing zone for scalar rules ported or adapted from Julia's
`ChainRules.jl` where they fit this crate boundary, but it is not a full port
of `ChainRules.jl`.

## Validation

Rules in this crate are not accepted on provenance alone. They are checked with
repository-local tests:

- `tests/scalarops_tests.rs` covers direct formulas, edge cases, and smooth
real/complex behavior
- `tests/julia_compat_trig_tests.rs` covers Julia migration helpers, including
landmark real inputs and representative Complex64 behavior
- `tests/nonsmooth_scalar_tests.rs` covers the documented zero-gradient and
tie-routing policies for non-smooth helpers
- `tests/complex_helper_tests.rs` covers the projection helpers and complex
constructor surface
- `tests/oracle_scalar_rules.rs` replays vendored published oracle cases from
`../../third_party/tensor-ad-oracles`, with direct float64 replay and
selected direct Complex64 replay for `tan`, `exp2`, and `log2`
- complex forward-mode checks use the standard JVP convention on `C ~= R^2`
in repository-local formula tests such as `tests/smooth_basis_tests.rs`
- complex reverse-mode checks remain conjugate-Wirtinger for real-valued losses

## Examples

```rust
use chainrules::{powf, powf_frule, powf_rrule};

let y = powf(2.0_f64, 3.0_f64);
assert_eq!(y, 8.0_f64);

let (y, dy) = powf_frule(2.0_f64, 3.0_f64, 1.0_f64);
assert_eq!(y, 8.0_f64);
assert_eq!(dy, 12.0_f64);

let dx = powf_rrule(2.0_f64, 3.0_f64, 1.0_f64);
assert_eq!(dx, 12.0_f64);
```

## Notes

This crate is the landing zone for shared scalar rule logic, including
Julia-style convenience functions when they help migration.

It does not define tensor, array, broadcast, reduction, or engine-specific
rules.
Loading
Loading