Add PR template, README, and contact links#3
Conversation
|
|
profile/README.md
Outdated
| ### First-class GPU support | ||
| GPU kernels can be written directly in Julia via [CUDA.jl](https://github.com/JuliaGPU/CUDA.jl). Flux is uniquely hackable and any part can be tweaked, from GPU code to custom gradients and layers. | ||
|
|
||
| ### The Model Zoo | ||
| A [rich collection](https://github.com/FluxML/model-zoo) of Flux scripts to learn from, or tweak to your own data. Trained Flux models can be used from [TextAnalysis](https://github.com/JuliaText/TextAnalysis.jl) or [Metalhead](https://github.com/FluxML/Metalhead.jl). |
There was a problem hiding this comment.
At some point we thought about toning down these claims, but I don't remember the specifics. @darsnack do you recall?
There was a problem hiding this comment.
Maybe this from model-zoo's README -
A collection of demonstrations of the Flux machine learning library. Any of these may freely be used as a starting point for your own models.
There was a problem hiding this comment.
That looks good. If we broaden the headline to be more like "Model Ecosystem", the inclusion of Metalhead would make sense as well. I would also nominate Transformers.jl and maybe Flux3D.
There was a problem hiding this comment.
In FluxML/fluxml.github.io#145 I simply removed the line. It's just misleading and drives people to the zoo where the get disappointed. My plan was to put it back in once we port the zoo examples and website tutorials into real tutorials that stay up to date in the docs.
I would remove any reference to the zoo here too. I think @mcabbott already toned done some claims on the docs?
There was a problem hiding this comment.
Found it - https://github.com/FluxML/Flux.jl/pull/2069/files#diff-36c852523b6a7513a10b8a6bae21f1037eaa27484efc9042f75bbda46d9f529bR6-R7. Maybe I should add in these 2 points too?
There was a problem hiding this comment.
Where does this readme show up?
I wonder if it shouldn't say almost nothing, and direct people to the website / the main Flux repository. Or point out that this is an "administrative" repository, like the one which backs the website, not a "user" one.
Having so many different advertising blurbs in different places seems a bit confusing, and harder to keep up to date.
(I indeed toned down some claims on the intro page of Flux's docs.)
There was a problem hiding this comment.
Fair point. This will show up like this - https://github.com/pybamm-team.
Co-authored-by: Brian Chen <[email protected]>
Co-authored-by: Brian Chen <[email protected]>
Closes #2
I am not sure if -
Flux.jlorFluxMLas a whole (and how?)cc: @ToucheSir