FluxML/Zygote.jl

Few issues in the Zygote Home Page documentation

Open

#1,503 opened on Feb 29, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (1,568 stars) (220 forks)batch import
good first issue

Description

The current issues listed here are referring to that in https://fluxml.ai/Zygote.jl/dev/# https://github.com/FluxML/Zygote.jl/blob/master/docs/src/index.md

  • First one being the link -> https://fluxml.ai/blog/2019/02/07/what-is-differentiable-programming.html , which is linked to "differentiable programming" is broken
  • Secondly coming to the colordiff example in the same page , when run on my system gives the output as 03CB23BD-D273-4504-8FD8-52B2586C125D_4_5005_c , while the example tends to give the grad output
  • Thirdly , in the last section of the page , the Implicit Parameters which uses Params , there has been a slight error in the flow of the example. 647E95CD-6EC9-4602-87DB-DE61A0980EF9 Here the x is a 2×3 Matrix{Int64} , whereas the W defined later is a 2×5 Matrix{Float64} , so the mismatch lies in the shape , I guess we can introduce x=rand(5), which would take care of the flow

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
none
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue lists three documentation problems in the Zygote.jl home page (docs/src/index.md and the live site). First, the link to differentiable programming is broken and needs an updated URL. Second, the colordiff example output does not match the expected gradient output and needs correction. Third, the implicit parameters example has a shape mismatch between x and W, requiring x to be changed to rand(5) for consistency.