Skip to content

Enhance transform and plot docs #479

Enhance transform and plot docs

Enhance transform and plot docs #479

Triggered via pull request September 15, 2023 12:42
Status Success
Total duration 15m 48s
Artifacts

CI.yml

on: pull_request
Matrix: Documentation
Matrix: test
Fit to window
Zoom out
Zoom in

Annotations

5 warnings
Documentation (1.9, ubuntu-latest, x64): ../../../.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl#L34
failed to run `@example` block in src/transformations.md:30-82 ```@example plot set_theme!(resolution=(800,200)) # hide fig = Figure() #hide data = zeros(Float64, 2, 2, 2, 2) #hide for i in 1:2 #hide for j in 1:2 #hide for k in 1:2 #hide data[i, i, j, k] = k #hide end #hide end #hide end #hide A = Tensor(data, (:i, :j, :k, :l)) #hide B = Tensor(rand(2, 2), (:i, :m)) #hide C = Tensor(rand(2, 2), (:j, :n)) #hide tn = TensorNetwork([A, B, C]) #hide reduced = transform(tn, Tenet.DiagonalReduction) #hide smooth_annotation!( #hide fig[1, 1]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = -0.21, #hide offset_y = -0.42, #hide radius_x = 0.38, #hide radius_y = 0.8, #hide num_waves = 6, #hide fluctuation_amplitude = 0.02, #hide phase_shift = 0.0) #hide plot!(fig[1, 1], tn, layout=Spring(iterations=1000, C=0.5, seed=100); node_color=[red, orange, orange, :black, :black,:black, :black]) #hide smooth_annotation!( #hide fig[1, 2]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = 0.1, #hide offset_y = -0.35, #hide radius_x = 0.38, #hide radius_y = 1.1, #hide num_waves = 5, #hide fluctuation_amplitude = 0.02, #hide phase_shift = 1.9) #hide plot!(fig[1, 2], reduced, layout=Spring(iterations=1000, C=0.5, seed=100), node_color=[orange, orange, red, :black, :black, :black, :black, :black]) #hide Label(fig[1, 1, Bottom()], "Original") #hide Label(fig[1, 2, Bottom()], "Transformed") #hide fig #hide ``` value = UndefVarError: `set_theme!` not defined
Documentation (1.9, ubuntu-latest, x64): ../../../.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl#L34
failed to run `@example` block in src/transformations.md:96-140 ```@example plot set_theme!(resolution=(800,200)) # hide fig = Figure() #hide A = Tensor(rand(2, 2, 2, 2), (:i, :j, :k, :l)) #hide B = Tensor(rand(2, 2), (:i, :m)) #hide C = Tensor(rand(2, 2, 2), (:m, :n, :o)) #hide E = Tensor(rand(2, 2, 2, 2), (:o, :p, :q, :j)) #hide tn = TensorNetwork([A, B, C, E]) #hide reduced = transform(tn, Tenet.RankSimplification) #hide smooth_annotation!( #hide fig[1, 1]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = -0.32, #hide offset_y = -0.5, #hide radius_x = 0.25, #hide radius_y = 0.94, #hide num_waves = 6, #hide fluctuation_amplitude = 0.01, #hide phase_shift = 0.0) #hide plot!(fig[1, 1], tn, layout=Spring(iterations=1000, C=0.5, seed=20); node_color=[orange, red, orange, orange, :black, :black, :black, :black, :black]) #hide smooth_annotation!( #hide fig[1, 2]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = 0.12, #hide offset_y = -0.62, #hide radius_x = 0.18, #hide radius_y = 0.46, #hide num_waves = 5, #hide fluctuation_amplitude = 0.01, #hide phase_shift = 0) #hide plot!(fig[1, 2], reduced, layout=Spring(iterations=1000, C=0.5, seed=1); node_color=[red, orange, orange, :black, :black, :black, :black, :black]) #hide Label(fig[1, 1, Bottom()], "Original") #hide Label(fig[1, 2, Bottom()], "Transformed") #hide fig #hide ``` value = UndefVarError: `set_theme!` not defined
Documentation (1.9, ubuntu-latest, x64): ../../../.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl#L34
failed to run `@example` block in src/transformations.md:148-194 ```@example plot set_theme!(resolution=(800,200)) # hide fig = Figure() #hide data = rand(3, 3, 3) #hide data[:, 1:2, :] .= 0 #hide A = Tensor(data, (:i, :j, :k)) #hide B = Tensor(rand(3, 3), (:j, :l)) #hide C = Tensor(rand(3, 3), (:l, :m)) #hide tn = TensorNetwork([A, B, C]) #hide reduced = transform(tn, Tenet.ColumnReduction) #hide smooth_annotation!( #hide fig[1, 1]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = -1.12, #hide offset_y = -0.22, #hide radius_x = 0.35, #hide radius_y = 0.84, #hide num_waves = 4, #hide fluctuation_amplitude = 0.02, #hide phase_shift = 0.0) #hide plot!(fig[1, 1], tn, layout=Spring(iterations=1000, C=0.5, seed=6); node_color=[red, orange, orange, :black, :black, :black]) #hide smooth_annotation!( #hide fig[1, 2]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = -0.64, #hide offset_y = 1.2, #hide radius_x = 0.32, #hide radius_y = 0.78, #hide num_waves = 5, #hide fluctuation_amplitude = 0.02, #hide phase_shift = 0) #hide Label(fig[1, 1, Bottom()], "Original") #hide Label(fig[1, 2, Bottom()], "Transformed") #hide plot!(fig[1, 2], reduced, layout=Spring(iterations=2000, C=40, seed=8); node_color=[red, orange, orange, :black, :black, :black]) #hide fig #hide ``` value = UndefVarError: `set_theme!` not defined
Documentation (1.9, ubuntu-latest, x64): ../../../.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl#L34
failed to run `@example` block in src/transformations.md:202-248 ```@example plot set_theme!(resolution=(800,200)) # hide fig = Figure() #hide v1 = Tensor([1, 2, 3], (:i,)) #hide v2 = Tensor([4, 5, 6], (:j,)) #hide m1 = Tensor(rand(3, 3), (:k, :l)) #hide t1 = contract(v1, v2) #hide tensor = contract(t1, m1) #hide tn = TensorNetwork([tensor, Tensor(rand(3, 3, 3), (:k, :m, :n)), Tensor(rand(3, 3, 3), (:l, :n, :o))]) #hide reduced = transform(tn, Tenet.SplitSimplification) #hide smooth_annotation!( #hide fig[1, 1]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = 0.24, #hide offset_y = 0.6, #hide radius_x = 0.32, #hide radius_y = 0.78, #hide num_waves = 5, #hide fluctuation_amplitude = 0.015, #hide phase_shift = 0.0) #hide plot!(fig[1, 1], tn, layout=Spring(iterations=10000, C=0.5, seed=12); node_color=[red, orange, orange, :black, :black, :black, :black]) #hide smooth_annotation!( #hide fig[1, 2]; #hide color = bg_blue, #hide xlims = [-2, 2], #hide ylims = [-2, 2], #hide offset_x = -0.2, #hide offset_y = -0.4, #hide radius_x = 1.1, #hide radius_y = 0.75, #hide num_waves = 3, #hide fluctuation_amplitude = 0.18, #hide phase_shift = 0.8) #hide Label(fig[1, 1, Bottom()], "Original") #hide Label(fig[1, 2, Bottom()], "Transformed") #hide plot!(fig[1, 2], reduced, layout=Spring(iterations=10000, C=13, seed=151); node_color=[orange, orange, red, red, red, :black, :black, :black, :black]) #hide fig #hide ``` value = UndefVarError: `set_theme!` not defined
Documentation (1.9, ubuntu-latest, x64): ../../../.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl#L34
13 docstrings not included in the manual: Tenet.layers :: Union{Tuple{As}, Tuple{TensorNetwork{As}, Any}} where As<:Tenet.Composite Base.:* :: Tuple{Tensor, Tensor} Tenet.ansatz :: Union{Tuple{Type{<:TensorNetwork{A}}}, Tuple{A}} where A Tenet.untag! :: Tuple{Tensor, String} Base.in :: Tuple{Tensor, TensorNetwork} Tenet.Arbitrary Tenet.letter :: Tuple{Any} Tenet.marginal :: Tuple{Any, Any} Tenet.tags :: Tuple{Tensor} Tenet.tag! :: Tuple{Tensor, String} Tenet.Ansatz Tenet.Composite Tenet.hastag :: Tuple{Tensor, String} These are docstrings in the checked modules (configured with the modules keyword) that are not included in @docs or @autodocs blocks.