refactor readme according to new website#2407
refactor readme according to new website#2407Priyansi wants to merge 7 commits intopytorch:masterfrom
Conversation
|
Thanks for the PR @Priyansi
Let's reduce even more:
Let's rework:
|
|
from user and learner viewpoint, I wanted to add a request, can you please change https://github.com/bibhabasumohapatra/ignite#tldr IDE theme and use a much cool looking GIF. |
|
Thanks for the suggestion @bibhabasumohapatra ! Did you have something in mind? |
|
Maybe it misses a link to https://PyTorch-ignite.ai Or maybe I missed it 😉 |
|
@sdesrozis please also review |
| - [](https://colab.research.google.com/github/pytorch/ignite/blob/master/examples/notebooks/Cifar10_Ax_hyperparam_tuning.ipynb) [Hyperparameters tuning with | ||
| Ax](https://github.com/pytorch/ignite/blob/master/examples/notebooks/Cifar10_Ax_hyperparam_tuning.ipynb) |
There was a problem hiding this comment.
@Priyansi do we have somewhere a discoverable link on this tutorial ?
There was a problem hiding this comment.
i can add these tutorials here - https://pytorch-ignite.ai/tutorials/
There was a problem hiding this comment.
Sounds good as a temporary solution
There was a problem hiding this comment.
vfdev-5
left a comment
There was a problem hiding this comment.
Looks good to me, just few questions remains:
- non-ported tutorials should still be discoverable
- should we remove/simplify "Why Ignite" ?
@sdesrozis @trsvchn thoughts ?
|
Maybe "Why Ignite" could be replaced by a sort of "How To" ? Although I think it can be removed if we extend the library short description. Otherwise it looks good to me ! |
Just to clarify, How To means different use cases for the library right? |
|
@Priyansi let's merge and reduce "Documentation and Getting Started" and "Other Documentation" |
Here is an example: |
|
@vfdev-5 is it okay now? |
Co-authored-by: vfdev <[email protected]>
| # Documentation and Getting Started | ||
|
|
||
| ## Additional Materials | ||
| The website for the library containing an overview can be found at: https://pytorch-ignite.ai/. Here is the order we suggest for getting started: |
There was a problem hiding this comment.
| The website for the library containing an overview can be found at: https://pytorch-ignite.ai/. Here is the order we suggest for getting started: | |
| The website for the library containing an overview can be found at: [pytorch-ignite.ai](https://pytorch-ignite.ai). Here is the order we suggest for getting started: |
| The easiest way to create your training scripts with PyTorch-Ignite: | ||
| - https://code-generator.pytorch-ignite.ai/ | ||
|
|
||
| The easiest way to create your training scripts with PyTorch-Ignite: https://code-generator.pytorch-ignite.ai/ |
There was a problem hiding this comment.
| The easiest way to create your training scripts with PyTorch-Ignite: https://code-generator.pytorch-ignite.ai/ | |
| The easiest way to create your training scripts with PyTorch-Ignite: [code-generator.pytorch-ignite.ai](https://code-generator.pytorch-ignite.ai/) |
Related to #2302
Description: Removed large chunks of information in README with links to the new website.
Check list: