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

Update tutorials for 0.7.0 API #691

Closed
lgvaz opened this issue Mar 16, 2021 · 5 comments
Closed

Update tutorials for 0.7.0 API #691

lgvaz opened this issue Mar 16, 2021 · 5 comments
Labels
discussion documentation Improvements or additions to documentation good first issue Good for newcomers priority-high

Comments

@lgvaz
Copy link
Collaborator

lgvaz commented Mar 16, 2021

There are actually two issues to be addressed here:

  1. Updating the tutorials to the newest API
  2. Restructuring the organization of the tutorials
  3. Make sure all tutorials are working as expected (model training, records parsed, etc)

The first issue is straight forward and we can use this document as a reference on what needs to be updated.

The second issue requires more thought and discussion. The main current problem is that we have a lot of repetition between our tutorials and this makes it very hard to maintain and update whenever we change something. We need a structure that reduces duplication while still showcasing all our features (and specially the support for multiple models).

Suggestion 1

image

The notebooks under training are minimal (almost without any text) and just showcase how to train a particular model. Here is an example of a minimal notebook.

@lgvaz lgvaz added discussion documentation Improvements or additions to documentation labels Mar 16, 2021
@lgvaz
Copy link
Collaborator Author

lgvaz commented Mar 16, 2021

Once this is done we can open issues for each individual tutorial

@mayankjainllrl
Copy link

mayankjainllrl commented Mar 16, 2021

Hey, I am python developer thinking of getting started with open source works. I am new to open source world haven't contributed anything. Thought I could get started by working on this issue under your mentorship and guidance.
@lgvaz

@lgvaz
Copy link
Collaborator Author

lgvaz commented Mar 16, 2021

@mayankjainllrl hi hi! Thanks for reaching out! Please join our discord forum so we can communicate better =)
https://discord.gg/JDBeZYK

@neelriyer
Copy link

@lgvaz I've updated the negative_samples tutorial as per the transition doc.
https://github.com/spiyer99/icevision/blob/master/notebooks/negative_samples.ipynb

Am I on the right track here? It seems like most of the other tutorials have already been updated.

@FraPochetti
Copy link
Contributor

Working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation Improvements or additions to documentation good first issue Good for newcomers priority-high
Projects
None yet
Development

No branches or pull requests

4 participants