Skip to content

Commit 6559e32

Browse files
committed
rename everything
1 parent 138f46f commit 6559e32

7 files changed

Lines changed: 17 additions & 52 deletions

File tree

LICENSE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
The ChainRulesCore.jl package is licensed under the MIT "Expat" License:
1+
The ChainRulesOverloadGeneration.jl package is licensed under the MIT "Expat" License:
22

33
> Copyright (c) 2018-2019: Jarrett Revels, and other JuliaDiff Contributors:
4-
> https://github.com/JuliaDiff/ChainRulesCore.jl/contributors
4+
> https://github.com/JuliaDiff/ChainRulesOverloadGeneration.jl/contributors
55
>
66
> Permission is hereby granted, free of charge, to any person obtaining a copy
77
> of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
<img src="https://rawcdn.githack.com/JuliaDiff/ChainRulesCore.jl/b0b8dbf26807f8f6bc1a3c073b6720b8d90a8cd4/docs/src/assets/logo.svg" width="256"/>
22

3-
# ChainRulesCore
3+
# ChainRulesOverloadGeneration
44

5-
[![Build Status](https://github.com/JuliaDiff/ChainRulesCore.jl/workflows/CI/badge.svg)](https://github.com/JuliaDiff/ChainRulesCore.jl/actions?query=workflow:CI)
6-
[![Coverage](https://codecov.io/gh/JuliaDiff/ChainRulesCore.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaDiff/ChainRulesCore.jl)
5+
[![Build Status](https://github.com/JuliaDiff/ChainRulesOverloadGeneration.jl/workflows/CI/badge.svg)](https://github.com/JuliaDiff/ChainRulesOverloadGeneration.jl/actions?query=workflow:CI)
6+
[![Coverage](https://codecov.io/gh/JuliaDiff/ChainRulesOverloadGeneration.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaDiff/ChainRulesOverloadGeneration.jl)
77
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
88
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
99
[![DOI](https://zenodo.org/badge/199721843.svg)](https://zenodo.org/badge/latestdoi/199721843)
1010

1111
**Docs:**
12-
[![](https://img.shields.io/badge/docs-master-blue.svg)](https://juliadiff.org/ChainRulesCore.jl/dev)
13-
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliadiff.org/ChainRulesCore.jl/stable)
12+
[![](https://img.shields.io/badge/docs-master-blue.svg)](https://juliadiff.org/ChainRulesOverloadGeneration.jl/dev)
13+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliadiff.org/ChainRulesOverloadGeneration.jl/stable)
1414

15-
The ChainRulesCore package provides a light-weight dependency for defining sensitivities for functions in your packages, without you needing to depend on ChainRules itself.
15+
The ChainRulesOverloadGeneration package provides a light-weight dependency for defining sensitivities for functions in your packages, without you needing to depend on ChainRules itself.
1616

1717
This will allow your package to be used with [ChainRules.jl](https://github.com/JuliaDiff/ChainRules.jl), which aims to provide a variety of common utilities that can be used by downstream automatic differentiation (AD) tools to define and execute forward-, reverse-, and mixed-mode primitives.
1818

docs/make.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ DocMeta.setdocmeta!(
1919
end
2020
)
2121

22-
indigo = DocThemeIndigo.install(ChainRulesCore)
22+
indigo = DocThemeIndigo.install(ChainRulesOverloadGeneration)
2323

2424
makedocs(
25-
modules=[ChainRulesCore],
25+
modules=[ChainRulesOverloadGeneration],
2626
format=Documenter.HTML(
2727
prettyurls=false,
2828
assets=[indigo],
@@ -67,6 +67,6 @@ makedocs(
6767
)
6868

6969
deploydocs(
70-
repo = "github.com/JuliaDiff/ChainRulesCore.jl.git",
70+
repo = "github.com/JuliaDiff/ChainRulesOverloadGeneration.jl.git",
7171
push_preview=true,
7272
)

docs/src/api.md

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
11
# API Documentation
22

3-
## Rules
43
```@autodocs
5-
Modules = [ChainRulesCore]
6-
Pages = ["rules.jl"]
7-
Private = false
8-
```
9-
10-
## Rule Definition Tools
11-
```@autodocs
12-
Modules = [ChainRulesCore]
4+
Modules = [ChainRulesOverloadGeneration]
135
Pages = ["rule_definition_tools.jl"]
146
Private = false
157
```
168

17-
## Differentials
18-
```@autodocs
19-
Modules = [ChainRulesCore]
20-
Pages = [
21-
"differentials/abstract_zero.jl",
22-
"differentials/one.jl",
23-
"differentials/composite.jl",
24-
"differentials/thunks.jl",
25-
"differentials/abstract_differential.jl",
26-
"differentials/notimplemented.jl",
27-
]
28-
Private = false
29-
```
30-
31-
## Accumulation
32-
```@docs
33-
add!!
34-
ChainRulesCore.is_inplaceable_destination
35-
```
36-
37-
## Ruleset Loading
38-
```@autodocs
39-
Modules = [ChainRulesCore]
40-
Pages = ["ruleset_loading.jl"]
41-
Private = false
42-
```
43-
449
## Internal
4510
```@docs
46-
ChainRulesCore.AbstractTangent
47-
ChainRulesCore.debug_mode
48-
ChainRulesCore.clear_new_rule_hooks!
11+
ChainRulesOverloadGeneration.clear_new_rule_hooks!
4912
```

src/ruleset_loading.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Excluding the fallback rule that returns `nothing` for every input.
6060
"""
6161
function _rule_list end
6262
# The fallback rules are the only rules defined in ChainRulesCore & that is how we skip them
63+
# TODO this needs to be changed to work now it is in it's own repo
6364
_rule_list(rule_kind) = (m for m in methods(rule_kind) if m.module != @__MODULE__)
6465

6566

test/demos/reversediffzero.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
"The simplest viable reverse mode a AD, only supports `Float64`"
22
module ReverseDiffZero
33
using ChainRulesCore
4+
using ChainRulesOverloadGeneration
45
using Test
56

67
#########################################

test/ruleset_loading.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
op = sig.parameters[1]
1111
push!(rrule_history, op)
1212
end
13-
13+
1414
@testset "new rules hit the hooks" begin
1515
# Now define some rules
1616
@scalar_rule x + y (1, 1)
@@ -38,7 +38,7 @@
3838
end
3939

4040
@testset "_primal_sig" begin
41-
_primal_sig = ChainRulesCore._primal_sig
41+
_primal_sig = ChainRulesOverloadGeneration._primal_sig
4242
@testset "frule" begin
4343
@test isequal( # DataType without shared type but with constraint
4444
_primal_sig(frule, Tuple{typeof(frule), Any, typeof(*), Int, Vector{Int}}),

0 commit comments

Comments
 (0)