search

pytorch / ignite

High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.
https://pytorch-ignite.ai
BSD 3-Clause "New" or "Revised" License
4.51k stars 610 forks source link

Improve the docs and README #925

Closed vfdev-5 closed 4 years ago

vfdev-5 commented 4 years ago

🚀 Feature

According to the feedback we had from various sources:

For me it took time to really understand the advantages of using the package. The docs i read were explanatory and didn't talked enough about the big picture... but maybe it is there on pages i didn't read :-)

Description of a real case study

  • Put results in numbers Use-cases
  • Problem, solution, results White-papers
  • Step-by-step how to solve the problem

Other nice examples:

vfdev-5 commented 4 years ago

Idea for quickstart tutorial, do something like here : https://captum.ai/#quickstart

cc @erip @sdesrozis