Skip to content
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.

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

Make readme ready for public usage #201

Closed
4 tasks done
ArneBinder opened this issue Aug 4, 2022 · 0 comments
Closed
4 tasks done

Make readme ready for public usage #201

ArneBinder opened this issue Aug 4, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ArneBinder
Copy link
Owner

ArneBinder commented Aug 4, 2022

Until #183 is implemented, we need at least descriptions for the most relevant parts of PyTorch-IE in the readme to make it usable by the public. This may require the following (entries marked with (!) are mandatory in my opinion).

PyTorch-IE MVP readme TODOs:

  • add "Architecture" section (Chris): short intro that says that we have Datasets made of Documents -> Taskmodule -> Model and how these parts interact
  • add "Taskmodule" section (Chris)
  • cleanup of examples sections (Arne): Improve readme examples #203
  • add content for "Development Setup" (Chris)

Note: IMO this is the last missing step before we can start promoting PyTorch-IE in any means.

@ArneBinder ArneBinder added the documentation Improvements or additions to documentation label Aug 4, 2022
@ArneBinder ArneBinder linked a pull request Aug 9, 2022 that will close this issue
@ArneBinder ArneBinder removed a link to a pull request Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant