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

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

refactor readme according to new website #2407

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a20cfe
removed info with new website links
Priyansi Jan 4, 2022
02574db
removed more redundant parts
Priyansi Jan 4, 2022
7c600d1
resolve conflicts
Priyansi Mar 14, 2022
024bb8d
addressed comments
Priyansi Mar 14, 2022
833ff80
merge doc and other doc sections
Priyansi Mar 22, 2022
ee50323
reduce other documentation
Priyansi Mar 22, 2022
3aee4c4
Update README.md
Priyansi Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,27 +256,20 @@ Checkout this guide to [install PyTorch-Ignite from source or use pre-built dock

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:


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

Apart from the above, here are some other helpful links:

- Stable API documentation: https://pytorch.org/ignite/
- Development version API documentation: https://pytorch.org/ignite/master/
- ["Questions on Github"](https://github.com/pytorch/ignite/issues?q=is%3Aissue+label%3Aquestion+) and
["Questions on Discuss.PyTorch"](https://discuss.pytorch.org/c/ignite).
- [Project's Roadmap](https://github.com/pytorch/ignite/wiki/Roadmap)
- [Talks](https://pytorch-ignite.ai/talks/)
1. [Getting Started Guide](https://pytorch-ignite.ai/tutorials/beginner/01-getting-started/) for essentials of setting up a project.
2. [Tutorials](https://pytorch-ignite.ai/tutorials/) for the beginner, intermediate and advanced user.
3. [How-to Guides](https://pytorch-ignite.ai/how-to-guides/) for code recipes with minimal explanation.
4. [Concepts](https://pytorch-ignite.ai/concepts/) to understand the essence of the library.
5. [Stable](https://pytorch.org/ignite/) / [Development](https://pytorch.org/ignite/master/) API documentations.
6. Previously asked questions on [Github](https://github.com/pytorch/ignite/issues?q=is%3Aissue+label%3Aquestion+) and [Discuss.PyTorch](https://discuss.pytorch.org/c/ignite).
7. [Talks](https://pytorch-ignite.ai/talks/) for visual learners.
8. [Project's Roadmap](https://github.com/pytorch/ignite/wiki/Roadmap) to look out for upcoming features.

<!-- ############################################################################################################### -->

## Code-Generator application

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/

<!-- ############################################################################################################### -->

Expand Down