Skip to content

Leftover changes from #2046 #2055

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

Merged
merged 1 commit into from
Aug 29, 2022
Merged

Leftover changes from #2046 #2055

merged 1 commit into from
Aug 29, 2022

Conversation

Saransh-cpp
Copy link
Member

@mcabbott, I was about to make these changes in #2046, but it was merged. I have added them in this follow-up PR -

  • remove linear_regression.jl (committed by mistake)
  • @ToucheSir's comments
  • Update Functor.jl's sidebar title

PR Checklist

  • Tests are added
  • Entry in NEWS.md
  • Documentation, if applicable

* remove linear_regression.jl (commited by mistake)

* @ToucheSir's comments

* Update Functor.jl's sidebar title
Comment on lines 21 to 25
"Neural Network primitives from NNlib.jl" => "models/nnlib.md",
"Functor from Functors.jl" => "models/functors.md"
"Recursive transformations from Functors.jl" => "models/functors.md"
],
"Handling Data" => [
"One-Hot Encoding with OneHotArrays.jl" => "data/onehot.md",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry if I rushed it. At least this way it's easy to see the preview, https://fluxml.ai/Flux.jl/dev/

I wonder whether all the sidebar titles should be just the package name, not the description? This would make a bit of a distinction between internal and external docs, and would fit on one line each.

Screenshot 2022-08-29 at 14 29 53

@mcabbott
Copy link
Member

mcabbott commented Aug 29, 2022

While fiddling, is there a better way to organise this bit of the docs? It feels a bit like random things are dumped down here.

Screenshot 2022-08-29 at 14 54 48

There has got to be a better way to organise this material, but I'm not exactly sure what what the right top-level headings are.

Under "utilities" this groups:

  • All the init functions do need to live somewhere. It's a long list. Maybe it should be a subsection near to NNlib? (Maybe NNlib should be two sections, in fact -- one to list the activation functions which you use, another for the backend functions your layers use?)
  • "Model Building" means outputsize. It's nice but nobody will find it here.
  • "Model Abstraction" just means Flux.modules. Since this is almost fcollect should it live with Functors.jl, or are those sections exclusively functions from the package?
  • "Changing the type" should this live with initialisaton, or live with Functors.jl?
  • "Callback helpers" are very random. Maybe they should live as a subsection under "Training Models"

Maybe a new top section "Handling Models" could hold loading/saving, outputsize, modules.

The top-level heading "datasets" has two links. Can it just move to "ecosystem"?

Also can that be "The Flux Ecosystem" not the Julia one? It's things somewhat connected to Flux, and is a nice list. Or "Flux's Ecosystem", or "Ecosystem around Flux".

Can the "Community" heading be deleted? It could move to a sub-heading on the very first page, and perhaps also under "ecosystem"?


Edit: This need not be this PR, just thinking aloud really.

@ToucheSir ToucheSir merged commit c04210c into FluxML:master Aug 29, 2022
@Saransh-cpp Saransh-cpp deleted the leftover branch August 31, 2022 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants