Skip to content

Add PR template, README, and contact links#3

Merged
ToucheSir merged 13 commits intoFluxML:mainfrom
Saransh-cpp:revamp
Oct 12, 2022
Merged

Add PR template, README, and contact links#3
ToucheSir merged 13 commits intoFluxML:mainfrom
Saransh-cpp:revamp

Conversation

@Saransh-cpp
Copy link
Member

Closes #2

I am not sure if -

  • I should add a generic bug report and feature request template to this repository.
  • the README should describe Flux.jl or FluxML as a whole (and how?)

cc: @ToucheSir

@ToucheSir
Copy link
Member

  1. If project-specific templates can override this, then I'd say go for it.
  2. Definitely FluxML. You could borrow some of the description from the website for this.

@Saransh-cpp
Copy link
Member Author

Comment on lines 19 to 23
### 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).
Copy link
Member

Choose a reason for hiding this comment

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

At some point we thought about toning down these claims, but I don't remember the specifics. @darsnack do you recall?

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

@darsnack darsnack Oct 12, 2022

Choose a reason for hiding this comment

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

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?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

@mcabbott mcabbott Oct 12, 2022

Choose a reason for hiding this comment

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

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.)

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair point. This will show up like this - https://github.com/pybamm-team.

@Saransh-cpp Saransh-cpp requested a review from ToucheSir October 10, 2022 18:23
@Saransh-cpp Saransh-cpp requested a review from ToucheSir October 12, 2022 14:01
@ToucheSir ToucheSir merged commit 19b5e94 into FluxML:main Oct 12, 2022
@Saransh-cpp Saransh-cpp deleted the revamp branch October 17, 2022 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Discussion]: Flesh out FluxML/.github repository

4 participants