Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update version etc in docs #289

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
155 changes: 108 additions & 47 deletions docs/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ version = "0.0.1"

[[ArgTools]]
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
version = "1.1.1"

[[Artifacts]]
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
Expand All @@ -15,80 +16,91 @@ uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

[[ChainRulesCore]]
deps = ["Compat", "LinearAlgebra", "SparseArrays"]
git-tree-sha1 = "f885e7e7c124f8c92650d61b9477b9ac2ee607dd"
deps = ["Compat", "LinearAlgebra"]
git-tree-sha1 = "e0af648f0692ec1691b5d094b8724ba1346281cf"
uuid = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
version = "1.11.1"
version = "1.18.0"
weakdeps = ["SparseArrays"]

[ChainRulesCore.extensions]
ChainRulesCoreSparseArraysExt = "SparseArrays"

[[ChainRulesTestUtils]]
deps = ["ChainRulesCore", "Compat", "FiniteDifferences", "LinearAlgebra", "Random", "Test"]
deps = ["ChainRulesCore", "Compat", "FiniteDifferences", "LinearAlgebra", "Random", "Suppressor", "Test"]
path = ".."
uuid = "cdddcdb0-9152-4a09-a978-84456f9df70a"
version = "1.2.4"
version = "1.13.0"

[[Compat]]
deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "SHA", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
git-tree-sha1 = "dce3e3fea680869eaa0b774b2e8343e9ff442313"
deps = ["UUIDs"]
git-tree-sha1 = "886826d76ea9e72b35fcd000e535588f7b60f21d"
uuid = "34da2185-b29b-5c13-b0c7-acf172513d20"
version = "3.40.0"
version = "4.10.1"
weakdeps = ["Dates", "LinearAlgebra"]

[Compat.extensions]
CompatLinearAlgebraExt = "LinearAlgebra"

[[CompilerSupportLibraries_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae"
version = "1.0.5+0"

[[Dates]]
deps = ["Printf"]
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"

[[DelimitedFiles]]
deps = ["Mmap"]
uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"

[[Distributed]]
deps = ["Random", "Serialization", "Sockets"]
uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"

[[DocStringExtensions]]
deps = ["LibGit2"]
git-tree-sha1 = "b19534d1895d702889b219c382a6e18010797f0b"
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
version = "0.8.6"
version = "0.9.3"

[[Documenter]]
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
git-tree-sha1 = "f425293f7e0acaf9144de6d731772de156676233"
git-tree-sha1 = "39fd748a73dce4c05a9655475e437170d8fb1b67"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.27.10"
version = "0.27.25"

[[Downloads]]
deps = ["ArgTools", "LibCURL", "NetworkOptions"]
deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
version = "1.6.0"

[[FileWatching]]
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"

[[FiniteDifferences]]
deps = ["ChainRulesCore", "LinearAlgebra", "Printf", "Random", "Richardson", "StaticArrays"]
git-tree-sha1 = "c56a261e1a5472f20cbd7aa218840fd203243319"
deps = ["ChainRulesCore", "LinearAlgebra", "Printf", "Random", "Richardson", "SparseArrays", "StaticArrays"]
git-tree-sha1 = "d77e4697046989f44dce3ed66269aaf1611a3406"
uuid = "26cc04aa-876d-5657-8c51-4c34ba976000"
version = "0.12.19"
version = "0.12.31"

[[IOCapture]]
deps = ["Logging", "Random"]
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
git-tree-sha1 = "d75853a0bdbfb1ac815478bacd89cd27b550ace6"
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
version = "0.2.2"
version = "0.2.3"

[[InteractiveUtils]]
deps = ["Markdown"]
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

[[JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
version = "0.21.2"
version = "0.21.4"

[[LibCURL]]
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
version = "0.6.3"

[[LibCURL_jll]]
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
version = "7.84.0+0"

[[LibGit2]]
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
Expand All @@ -97,12 +109,13 @@ uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
[[LibSSH2_jll]]
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
version = "1.10.2+0"

[[Libdl]]
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"

[[LinearAlgebra]]
deps = ["Libdl"]
deps = ["Libdl", "OpenBLAS_jll", "libblastrampoline_jll"]
uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

[[Logging]]
Expand All @@ -115,25 +128,46 @@ uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
[[MbedTLS_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
version = "2.28.2+0"

[[Mmap]]
uuid = "a63ad114-7e13-5084-954f-fe012c677804"

[[MozillaCACerts_jll]]
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
version = "2022.10.11"

[[NetworkOptions]]
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
version = "1.2.0"

[[OpenBLAS_jll]]
deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"]
uuid = "4536629a-c528-5b80-bd46-f80d51c5b363"
version = "0.3.21+4"

[[Parsers]]
deps = ["Dates"]
git-tree-sha1 = "ae4bbcadb2906ccc085cf52ac286dc1377dceccc"
deps = ["Dates", "PrecompileTools", "UUIDs"]
git-tree-sha1 = "a935806434c9d4c506ba941871b327b96d41f2bf"
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
version = "2.1.2"
version = "2.8.0"

[[Pkg]]
deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
version = "1.9.2"

[[PrecompileTools]]
deps = ["Preferences"]
git-tree-sha1 = "03b4c25b43cb84cee5c90aa9b5ea0a78fd848d2f"
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
version = "1.2.0"

[[Preferences]]
deps = ["TOML"]
git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e"
uuid = "21216c6a-2e73-6563-6e65-726566657250"
version = "1.4.1"

[[Printf]]
deps = ["Unicode"]
Expand All @@ -144,49 +178,68 @@ deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

[[Random]]
deps = ["Serialization"]
deps = ["SHA", "Serialization"]
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[[Richardson]]
deps = ["LinearAlgebra"]
git-tree-sha1 = "e03ca566bec93f8a3aeb059c8ef102f268a38949"
git-tree-sha1 = "48f038bfd83344065434089c2a79417f38715c41"
uuid = "708f8203-808e-40c0-ba2d-98a6953ed40d"
version = "1.4.0"
version = "1.4.2"

[[SHA]]
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
version = "0.7.0"

[[Serialization]]
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"

[[SharedArrays]]
deps = ["Distributed", "Mmap", "Random", "Serialization"]
uuid = "1a1011a3-84de-559e-8e89-a11a2f7dc383"

[[Sockets]]
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"

[[SparseArrays]]
deps = ["LinearAlgebra", "Random"]
deps = ["Libdl", "LinearAlgebra", "Random", "Serialization", "SuiteSparse_jll"]
uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"

[[StaticArrays]]
deps = ["LinearAlgebra", "Random", "Statistics"]
git-tree-sha1 = "3c76dde64d03699e074ac02eb2e8ba8254d428da"
deps = ["LinearAlgebra", "PrecompileTools", "Random", "StaticArraysCore"]
git-tree-sha1 = "2aded4182a14b19e9b62b063c0ab561809b5af2c"
uuid = "90137ffa-7385-5640-81b9-e52037218182"
version = "1.2.13"
version = "1.8.0"

[StaticArrays.extensions]
StaticArraysChainRulesCoreExt = "ChainRulesCore"
StaticArraysStatisticsExt = "Statistics"

[StaticArrays.weakdeps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

[[Statistics]]
deps = ["LinearAlgebra", "SparseArrays"]
uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
[[StaticArraysCore]]
git-tree-sha1 = "36b3d696ce6366023a0ea192b4cd442268995a0d"
uuid = "1e83bf80-4336-4d27-bf5d-d5a4f845583c"
version = "1.4.2"

[[SuiteSparse_jll]]
deps = ["Artifacts", "Libdl", "Pkg", "libblastrampoline_jll"]
uuid = "bea87d4a-7f5b-5778-9afe-8cc45184846c"
version = "5.10.1+6"

[[Suppressor]]
deps = ["Logging"]
git-tree-sha1 = "6cd9e4a207964c07bf6395beff7a1e8f21d0f3b2"
uuid = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
version = "0.2.6"

[[TOML]]
deps = ["Dates"]
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
version = "1.0.3"

[[Tar]]
deps = ["ArgTools", "SHA"]
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
version = "1.10.0"

[[Test]]
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
Expand All @@ -202,11 +255,19 @@ uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
[[Zlib_jll]]
deps = ["Libdl"]
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
version = "1.2.13+0"

[[libblastrampoline_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "8e850b90-86db-534c-a0d3-1478176c7d93"
version = "5.8.0+0"

[[nghttp2_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
version = "1.48.0+0"

[[p7zip_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
version = "17.4.0+0"
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
The call will test the `frule` for function `f` at the point `x` in the domain.
Keep this in mind when testing discontinuous rules for functions like [ReLU](https://en.wikipedia.org/wiki/Rectifier_(neural_networks)), which should ideally be tested at both `x` being above and below zero.

```jldoctest ex

Check failure on line 67 in docs/src/index.md

View workflow job for this annotation

GitHub Actions / Documentation

doctest failure in src/index.md:67-73 ```jldoctest ex julia> using ChainRulesTestUtils; julia> test_frule(two2three, 3.33, -7.77); Test Summary: | Pass Total Time test_frule: two2three on Float64,Float64 | 6 6 2.7s ``` Subexpression: test_frule(two2three, 3.33, -7.77); Evaluated output: Test Summary: | Pass Total test_frule: two2three on Float64,Float64 | 6 6 Expected output: Test Summary: | Pass Total Time test_frule: two2three on Float64,Float64 | 6 6 2.7s diff = Warning: Diff output requires color. Test Summary: | Pass Total Time Total test_frule: two2three on Float64,Float64 | 6 6 2.7s6
julia> using ChainRulesTestUtils;

julia> test_frule(two2three, 3.33, -7.77);
Expand All @@ -78,7 +78,7 @@
[`test_rrule`](@ref) takes in the function `f`, and primal inputs `x`.
The call will test the `rrule` for function `f` at the point `x`, and similarly to `frule` some rules should be tested at multiple points in the domain.

```jldoctest ex

Check failure on line 81 in docs/src/index.md

View workflow job for this annotation

GitHub Actions / Documentation

doctest failure in src/index.md:81-88 ```jldoctest ex julia> test_rrule(two2three, 3.33, -7.77); test_rrule: two2three on Float64,Float64: Test Failed at /home/lior/.julia/dev/ChainRulesTestUtils/src/check_result.jl:24 Expression: isapprox(actual, expected; kwargs...) Problem: cotangent for input 2, Float64 Evaluated: isapprox(-4.032, -3.840000000001641; rtol = 1.0e-9, atol = 1.0e-9) [...] ``` Subexpression: test_rrule(two2three, 3.33, -7.77); Evaluated output: test_rrule: two2three on Float64,Float64: Test Failed at /home/runner/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/check_result.jl:24 Expression: Problem: cotangent for input 2, Float64 Evaluated: Stacktrace: [1] record(ts::Test.DefaultTestSet, t::Union{Test.Error, Test.Fail}) @ Test /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.6/Test/src/Test.jl:809 [2] do_test(result::Test.ExecutionResult, orig_expr::Any) @ Test /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.6/Test/src/Test.jl:555 [3] test_approx(actual::Union{Number, AbstractArray{var"#s46", N} where {var"#s46"<:Number, N}}, expected::Union{Number, AbstractArray{var"#s45", N} where {var"#s45"<:Number, N}}, msg::Any; kwargs::Any) @ ChainRulesTestUtils ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/check_result.jl:24 [4] _test_cotangent(accum_cotangent::Any, ad_cotangent::Any, fd_cotangent::Any, msg::Any; check_inferred::Any, kwargs::Any) @ ChainRulesTestUtils ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:312 [5] (::ChainRulesTestUtils.var"#65#70"{Bool, NamedTuple{(:rtol, :atol), Tuple{Float64, Float64}}})(::Any, ::Vararg{Any, N} where N) @ ChainRulesTestUtils ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:236 [6] foreach(::Function, ::Tuple{ChainRulesCore.NoTangent, Float64, Float64}, ::Tuple{ChainRulesCore.NoTangent, Float64, Float64}, ::Vararg{Any, N} where N) @ Base ./abstractarray.jl:2142 [7] macro expansion @ ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:235 [inlined] [8] macro expansion @ /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.6/Test/src/Test.jl:1151 [inlined] [9] test_rrule(::ChainRulesCore.RuleConfig, ::Any, ::Any, ::Vararg{Any, N} where N; output_tangent::Any, check_thunked_output_tangent::Any, fdm::Any, rrule_f::Any, check_inferred::Bool, fkwargs::NamedTuple, rtol::Real, atol::Real, testset_name::Any, kwargs::Any) @ ChainRulesTestUtils ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:205 [10] test_rrule @ ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:197 [inlined] [11] #test_rrule#62 @ ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:178 [inlined] [12] test_rrule(::Any, ::Any, ::Any) @ ChainRulesTestUtils ~/work/ChainRulesTestUtils.jl/ChainRulesTestUtils.jl/src/testers.jl:178 [13] top-level scope @ none:1 [14] eval @ ./boot.jl:360 [inlined] [15] #5 @ ~/.julia/packages/Documenter/bYYzK/src/DocTests.jl:245 [inlined] [16] (::IOCapture.var"#3#5"{DataType, Documenter.DocTests.var"#5#6"{Module}, Task, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/8Uj7o/src/IOCapture.jl:119 [17] with_logstate(f::Function, logstate::Any) @ Base.CoreLogging ./logging.jl:491 [18] with_logger @ ./logging.jl:603 [inlined] [19] capture(f::Documenter.DocTests.var"#5#6"{Module}; rethrow::Type, color::Bool) @ IOCapture ~/.julia/packages/IOCapture/8Uj7o/src/IOCapture.jl:116 [20] eval_repl(block::Documenter.DocTests.MutableMD2CodeBlock, sandbox::Module, meta::Dict{Symbol, Any}, doc::Documenter.Documents.Document, page::String) @ Documenter.DocTests ~/.julia/packages/Documenter/bYYzK/src/DocTests.jl:244 [21] doctest(ctx::Documenter.DocTests.DocTestContext, block_immutable::Documenter.Utilities.Markdown2.CodeBlock) @ Documenter.DocTests ~/.julia/packages/Documenter/bYYzK/src/Do
julia> test_rrule(two2three, 3.33, -7.77);
test_rrule: two2three on Float64,Float64: Test Failed at /home/lior/.julia/dev/ChainRulesTestUtils/src/check_result.jl:24
Expression: isapprox(actual, expected; kwargs...)
Expand Down Expand Up @@ -111,15 +111,15 @@

`test_scalar` function is provided to test both the `frule` and the `rrule` with a single
call.
```jldoctest ex

Check failure on line 114 in docs/src/index.md

View workflow job for this annotation

GitHub Actions / Documentation

doctest failure in src/index.md:114-123 ```jldoctest ex julia> test_scalar(relu, 0.5); Test Summary: | Pass Total Time test_scalar: relu at 0.5 | 11 11 0.5s julia> test_scalar(relu, -0.5); Test Summary: | Pass Total Time test_scalar: relu at -0.5 | 11 11 0.0s ``` Subexpression: test_scalar(relu, 0.5); Evaluated output: Test Summary: | Pass Total test_scalar: relu at 0.5 | 11 11 Expected output: Test Summary: | Pass Total Time test_scalar: relu at 0.5 | 11 11 0.5s diff = Warning: Diff output requires color. Test Summary: | Pass Total Time Total test_scalar: relu at 0.5 | 11 11 0.5s11

Check failure on line 114 in docs/src/index.md

View workflow job for this annotation

GitHub Actions / Documentation

doctest failure in src/index.md:114-123 ```jldoctest ex julia> test_scalar(relu, 0.5); Test Summary: | Pass Total Time test_scalar: relu at 0.5 | 11 11 0.5s julia> test_scalar(relu, -0.5); Test Summary: | Pass Total Time test_scalar: relu at -0.5 | 11 11 0.0s ``` Subexpression: test_scalar(relu, -0.5); Evaluated output: Test Summary: | Pass Total test_scalar: relu at -0.5 | 11 11 Expected output: Test Summary: | Pass Total Time test_scalar: relu at -0.5 | 11 11 0.0s diff = Warning: Diff output requires color. Test Summary: | Pass Total Time Total test_scalar: relu at -0.5 | 11 11 0.0s11
julia> test_scalar(relu, 0.5);
Test Summary: | Pass Total Time
test_scalar: relu at 0.5 | 12 12 1.2s
test_scalar: relu at 0.5 | 11 11 0.5s


julia> test_scalar(relu, -0.5);
Test Summary: | Pass Total Time
test_scalar: relu at -0.5 | 12 12 0.0s
test_scalar: relu at -0.5 | 11 11 0.0s

```

Expand Down
Loading