Skip to content

refactor readme according to new website #2407

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

refactor readme according to new website #2407

wants to merge 7 commits into from

Conversation

@Priyansi
Copy link
Contributor

@Priyansi Priyansi commented Jan 4, 2022 •
edited by vfdev-5
Loading

Related to #2302

Description: Removed large chunks of information in README with links to the new website.

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Jan 4, 2022

Thanks for the PR @Priyansi
Let's make it even more concise, let's remove the following sections:

  • User feedback (we do not have any feedback of that type :) since then => remove)
  • Additional Materials, and update https://pytorch-ignite.ai/talks/ if needed
  • Table of contents

Let's reduce even more:

  • Projects using Ignite

Let's rework:

  • Why Ignite?
  • Other Documentation -> Documentation and update links

@bibhabasumohapatra
Copy link
Contributor

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.
only a suggestion, it attracts more eyes and users.

@Priyansi
Copy link
Contributor Author

Priyansi commented Jan 4, 2022

Thanks for the suggestion @bibhabasumohapatra ! Did you have something in mind?

@sdesrozis
Copy link
Contributor

Maybe it misses a link to https://PyTorch-ignite.ai

Or maybe I missed it 😉

trsvchn
trsvchn reviewed Jan 5, 2022
View reviewed changes
@vfdev-5 vfdev-5 requested a review from trsvchn March 14, 2022 11:21
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Mar 14, 2022

@sdesrozis please also review

vfdev-5
vfdev-5 reviewed Mar 14, 2022
View reviewed changes
README.md
Comment on lines -393 to -394
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

@Priyansi do we have somewhere a discoverable link on this tutorial ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i can add these tutorials here - https://pytorch-ignite.ai/tutorials/

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good as a temporary solution

Copy link
Contributor Author

Choose a reason for hiding this comment

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

pytorch-ignite/pytorch-ignite.ai#150

vfdev-5
vfdev-5 reviewed Mar 14, 2022
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Looks good to me, just few questions remains:

  • non-ported tutorials should still be discoverable
  • should we remove/simplify "Why Ignite" ?

@sdesrozis @trsvchn thoughts ?

@sdesrozis
Copy link
Contributor

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 !

@Priyansi
Copy link
Contributor Author

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.

Just to clarify, How To means different use cases for the library right?

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Mar 22, 2022

@Priyansi let's merge and reduce "Documentation and Getting Started" and "Other Documentation"

@Priyansi
Copy link
Contributor Author

@Priyansi let's merge and reduce "Documentation and Getting Started" and "Other Documentation"

@vfdev-5 I'm not sure how to reduce this section further. The order for getting started is necessary, Apart from that, should I scrape the issues, discussions and roadmap links?

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Mar 22, 2022

@Priyansi let's merge and reduce "Documentation and Getting Started" and "Other Documentation"

@vfdev-5 I'm not sure how to reduce this section further. The order for getting started is necessary, Apart from that, should I scrape the issues, discussions and roadmap links?

Here is an example:


# Documentation and Getting Started

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:

1. [Getting Started Guide for essentials of setting up a project](https://pytorch-ignite.ai/tutorials/beginner/01-getting-started/)
2. [Tutorials for the beginner, intermediate and advanced user](https://pytorch-ignite.ai/tutorials/)
3. [How-to Guides for code recipes with minimal explanation](https://pytorch-ignite.ai/how-to-guides/)
4. [Concepts to understand the essence of the library](https://pytorch-ignite.ai/concepts/)
5. [Stable](https://pytorch.org/ignite/) / [Development](https://pytorch.org/ignite/master/) API documentations

@Priyansi
Copy link
Contributor Author

@vfdev-5 is it okay now?

vfdev-5
vfdev-5 reviewed Mar 22, 2022
View reviewed changes
@Priyansi @vfdev-5
Update README.md
3aee4c4 
Co-authored-by: vfdev <[email protected]>
RMeli
RMeli reviewed Mar 24, 2022
View reviewed changes
README.md
# 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:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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:

RMeli
RMeli reviewed Mar 24, 2022
View reviewed changes
README.md
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/
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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/)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vfdev-5 vfdev-5 vfdev-5 left review comments

@sdesrozis sdesrozis Awaiting requested review from sdesrozis

@fco-dv fco-dv Awaiting requested review from fco-dv

@trsvchn trsvchn Awaiting requested review from trsvchn

+1 more reviewer

@RMeli RMeli RMeli left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Priyansi @vfdev-5 @bibhabasumohapatra @sdesrozis @RMeli @trsvchn