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

Documentation for FasterAI updates #161

Merged
merged 27 commits into from
Aug 27, 2021
Merged

Documentation for FasterAI updates #161

merged 27 commits into from
Aug 27, 2021

Conversation

lorenzoh
Copy link
Member

@lorenzoh lorenzoh commented Aug 15, 2021

With the new FasterAI API, some changes should be made to the documentation.

ToDos

  • the simple examples for training a model should be replaced by their short, 5-line versions.
    • README.md
    • Colab
    • quickstart.md should use just the short versions
    • serialization.ipynb
    • introduction.md should pull apart the 5-liner and explain the slightly longer versions
  • the task-specific tutorials should be moved into the "intermediate" category:
    • image segmentation
    • image keypoint regression
  • how-tos for training should be condensed into a single notebook
  • some documentation sections need to be added:
    • a tutorial on using the high-level query functions
    • a tutorial on working with BlockMethods
  • The following need editing:
    • datacontainers.md: add high-level examples as motivation, maybe implement a recipe
    • apicomparison.md

@lorenzoh lorenzoh marked this pull request as draft August 15, 2021 15:55
@lorenzoh lorenzoh marked this pull request as ready for review August 27, 2021 17:18
@lorenzoh lorenzoh merged commit 4ad969c into master Aug 27, 2021
@lorenzoh lorenzoh deleted the lorenzoh/faster-ai-docs branch October 25, 2021 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant