Icevision: Clean tutorials

Created on 27 Jun 2020  路  5Comments  路  Source: airctic/icevision

We have a good variety of tutorials, but some of them have a lot of duplication, and there is not a clear order on how they should be read.

The first task is to rename the tutorials, we need to number them and improve the names.

For example, wheat.py should become 1 - Quickstart

Maybe some of the tutorials should even be deleted for sake of clarity.

It's also worth saying that not all tutorials need to show on the documentation. We select what tutorials we want to show in docs/source/tutorials

documentation good first issue help wanted priority-high

Most helpful comment

Quick link to access it with the issue. https://lgvaz.github.io/mantisshrimp/index.html

I will rename the tutorials.

Section Mantisshrimp Models

  1. Quickstart FasterRCNN.
  2. Advanced FasterRCNN

Section Mantisshrimp Hub

  1. Detr Fine-Tuning

Section Undertstanding Mantisshrimp Data

  1. Quickstart Parsers.

All 5 comments

Wheat.py is already made Quickstart 馃槃 I made this edit last time I pushed advanced tutorial.

Let's list out what to include in Beginner's docs and then what in advanced docs.

Wheat.py is already made Quickstart

I mean the name of the file itself as well =)

Quick link to access it with the issue. https://lgvaz.github.io/mantisshrimp/index.html

I will rename the tutorials.

Section Mantisshrimp Models

  1. Quickstart FasterRCNN.
  2. Advanced FasterRCNN

Section Mantisshrimp Hub

  1. Detr Fine-Tuning

Section Undertstanding Mantisshrimp Data

  1. Quickstart Parsers.

A lot better!. Maybe the Data section should go before the Hub section

Will do that.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

lgvaz picture lgvaz  路  5Comments

lgvaz picture lgvaz  路  5Comments

tugot17 picture tugot17  路  3Comments

lgvaz picture lgvaz  路  3Comments

ncduy0303 picture ncduy0303  路  3Comments