[Doc] reformat contents and add level up skills

docs/requirements.txt

@@ -17,3 +17,4 @@ tensorflow
 jupyter
 jupytext
 pandoc
+sphinx_panels

docs/source/conf.py

@@ -49,8 +49,14 @@
     # of objects in external projects
     "myst_parser",
     "nbsphinx",
+    "sphinx_panels",
 ]
 
+panels_add_bootstrap_css = False
+panels_delimiters = (r"^\-{3,}$", r"^\^{3,}$", r"^\+{3,}$")
+
+suppress_warnings = ["myst.xref_missing", "myst.iref_ambiguous"]
+
 autosummary_generate = True  # Turn on sphinx.ext.autosummary
 autodoc_member_order = "groupwise"
 autoclass_content = "both"

docs/source/docs/data-formats/supported_formats.md

@@ -1,4 +1,4 @@
-# Supported Dataset Formats
+# Supported Data Formats
 
 List of supported formats:
 - ADE20k (v2017) (import-only)

docs/source/docs/index.rst

@@ -2,37 +2,42 @@ Docs
 ####
 
 .. toctree::
+  :maxdepth: 1
   :hidden:
   :caption: Get Started
 
   get-started/introduction
   get-started/quick-start-guide/index
 
 .. toctree::
+  :maxdepth: 1
   :hidden:
-  :caption: Guides
+  :caption: Level Up
 
-  user-manual/index
-  data-formats/index
+  level-up/basic_skills/index
+  level-up/intermediate_skills/index
+  level-up/advanced_skills/index
 
 .. toctree::
+  :maxdepth: 1
   :hidden:
-  :caption: Level Up
+  :caption: Data Formats
 
-  level-up/basic_skills/index
-  level-up/intermediate_skills/index
+  data-formats/supported_formats
+  data-formats/media_formats
+  data-formats/datumaro_format
 
 .. toctree::
+  :maxdepth: 1
   :hidden:
-  :caption: Explanation
+  :caption: Command Line Reference
 
-  explanation/architecture
-  explanation/formats/index
-  explanation/plugins/index
+  command-reference/index
 
 .. toctree::
+  :maxdepth: 1
   :hidden:
-  :caption: Reference
+  :caption: API Reference
 
   reference/datumaro/datumaro
   reference/cli/cli
@@ -42,6 +47,23 @@ Docs
   reference/jupyter_notebook_examples/index
 
 .. toctree::
+  :maxdepth: 1
+  :hidden:
+  :caption: Explanation
+
+  explanation/architecture
+  explanation/formats/index
+  explanation/plugins/index
+
+.. toctree::
+  :maxdepth: 1
+  :hidden:
+  :caption: Misc
+
+  user-manual/index
+
+.. toctree::
+  :maxdepth: 1
   :hidden:
   :caption: Release Notes
 

docs/source/docs/level-up/advanced_skills/11_project_versioning.md

@@ -0,0 +1,28 @@
+# Project Versioning
+
+Datumaro aims to manipulate the project for both model and dataset versioning.
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```

docs/source/docs/level-up/advanced_skills/12_pseudo_label_generation.md

@@ -0,0 +1,28 @@
+# Pseudo Label Generation from a Given Model
+
+Datumaro aims to manipulate the project for both model and dataset versioning.
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```

docs/source/docs/level-up/advanced_skills/index.rst

@@ -0,0 +1,20 @@
+Advanced Skills
+###########
+
+.. panels::
+
+   .. link-button:: 11_project_versioning
+      :type: ref
+      :text: Level 11: Project Versioning
+      :classes: btn-outline-primary btn-block stretched-link
+
+   :badge:`ProjectCLI,badge-primary`
+
+   ---
+
+   .. link-button:: 12_pseudo_label_generation
+      :type: ref
+      :text: Level 12: Psuedo Label Generation
+      :classes: btn-outline-primary btn-block
+
+   :badge:`ProjectCLI,badge-primary`

docs/source/docs/level-up/basic_skills/01_project_manipulation.md

@@ -0,0 +1,28 @@
+# Project Manipulation
+
+Datumaro aims to manipulate the project for both model and dataset versioning.
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```

docs/source/docs/level-up/intermediate_skills/data_aggregation.md → docs/source/docs/level-up/basic_skills/02_dataset_download.md

@@ -1,4 +1,4 @@
-# Data Aggregation
+# Dataset Download and Describe
 
 Datumaro aims to refine data
 

docs/source/docs/level-up/intermediate_skills/data_exploration.md → docs/source/docs/level-up/basic_skills/03_dataset_import_export.md

@@ -1,4 +1,4 @@
-# Data Explorartion
+# Data Import and Export
 
 Datumaro aims to refine data
 

docs/source/docs/level-up/basic_skills/04_detect_data_format.md

@@ -0,0 +1,28 @@
+# Detect Data Format from an Unknown Dataset
+
+Datumaro aims to refine data
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```

docs/source/docs/level-up/basic_skills/index.rst

@@ -1,17 +1,40 @@
 Basic Skills
-#################
-
-.. toctree::
-   :maxdepth: 1
-
-   import
-   export
-   validate
-   visualize
-   filter
-   compare
-   transform
-   merge
-   split
-   search
-   generate
+###########
+
+.. panels::
+
+   .. link-button:: 01_project_manipulation
+      :type: ref
+      :text: Level 1: Project Manipulation
+      :classes: btn-outline-primary btn-block
+
+   :badge:`ProjectCLI,badge-primary`
+
+   ---
+
+   .. link-button:: 02_dataset_download
+      :type: ref
+      :text: Level 2: Dataset Download
+      :classes: btn-outline-primary btn-block
+
+   :badge:`CLI,badge-info`
+
+   ---
+
+   .. link-button:: 03_dataset_import_export
+      :type: ref
+      :text: Level 3: Dataset Import & Export
+      :classes: btn-outline-primary btn-block
+
+   :badge:`CLI,badge-info`
+   :badge:`Python,badge-warning`
+
+   ---
+
+   .. link-button:: 04_detect_data_format
+      :type: ref
+      :text: Level 4: Detect Data Format
+      :classes: btn-outline-primary btn-block
+
+   :badge:`CLI,badge-info`
+   :badge:`Python,badge-warning`

docs/source/docs/level-up/intermediate_skills/data_merge.md → docs/source/docs/level-up/intermediate_skills/05_data_aggregation.md

@@ -1,4 +1,4 @@
-# Data Merge
+# Data Subset Aggregation
 
 Datumaro aims to refine data
 

docs/source/docs/level-up/intermediate_skills/06_data_comparison.md

@@ -0,0 +1,28 @@
+# Data Comparison with Two Heterogeneous Datasets
+
+Datumaro aims to refine data
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```

docs/source/docs/level-up/intermediate_skills/data_comparison.md → docs/source/docs/level-up/intermediate_skills/07_data_merge.md

@@ -1,4 +1,4 @@
-# Data Comparison
+# Merge Two Heterogeneous Datasets
 
 Datumaro aims to refine data
 

docs/source/docs/level-up/intermediate_skills/08_data_refinement.md

@@ -0,0 +1,28 @@
+# Dataset Refinement with Validation Report
+
+Datumaro aims to refine data
+
+``` bash
+datum create -o <project/dir>
+datum import -p <project/dir> -f image_dir <directory/path/>
+```
+
+or, if you work with Datumaro API:
+
+- for using with a project:
+
+  ```python
+  from datumaro.project import Project
+
+  project = Project.init()
+  project.import_source('source1', format='image_dir', url='directory/path/')
+  dataset = project.working_tree.make_dataset()
+  ```
+
+- for using as a dataset:
+
+  ```python
+  from datumaro import Dataset
+
+  dataset = Dataset.import_from('directory/path/', 'image_dir')
+  ```