From 9c7e6d69079e515da0091197dc07312838de037f Mon Sep 17 00:00:00 2001
From: nateraw <nxr9266@g.rit.edu>
Date: Fri, 2 Dec 2022 01:02:58 -0500
Subject: [PATCH] :art: structure docs

---
 hfdocs/README.md                         | 14 ++++++++++++
 hfdocs/source/_toctree.yml               | 29 +++++++++++++++++++++---
 hfdocs/source/hf_hub.mdx                 |  3 +++
 hfdocs/source/index.mdx                  |  4 ++++
 hfdocs/source/inference.mdx              |  3 +++
 hfdocs/source/installation.mdx           |  3 +++
 hfdocs/source/quickstart.mdx             |  3 +++
 hfdocs/source/reference/augmentation.mdx |  3 +++
 hfdocs/source/reference/data.mdx         |  3 +++
 hfdocs/source/reference/models.mdx       |  3 +++
 hfdocs/source/reference/optimization.mdx |  3 +++
 hfdocs/source/training_script.mdx        |  3 +++
 12 files changed, 71 insertions(+), 3 deletions(-)
 create mode 100644 hfdocs/README.md
 create mode 100644 hfdocs/source/hf_hub.mdx
 create mode 100644 hfdocs/source/inference.mdx
 create mode 100644 hfdocs/source/installation.mdx
 create mode 100644 hfdocs/source/quickstart.mdx
 create mode 100644 hfdocs/source/reference/augmentation.mdx
 create mode 100644 hfdocs/source/reference/data.mdx
 create mode 100644 hfdocs/source/reference/models.mdx
 create mode 100644 hfdocs/source/reference/optimization.mdx
 create mode 100644 hfdocs/source/training_script.mdx

diff --git a/hfdocs/README.md b/hfdocs/README.md
new file mode 100644
index 00000000..f8819c49
--- /dev/null
+++ b/hfdocs/README.md
@@ -0,0 +1,14 @@
+# Hugging Face Timm Docs
+
+## Getting Started
+
+```
+pip install git+https://github.com/huggingface/doc-builder.git@main#egg=hf-doc-builder
+pip install watchdog black
+```
+
+## Preview the Docs Locally
+
+```
+doc-builder preview pytorch-image-models hfdocs/source --not_python_module
+```
diff --git a/hfdocs/source/_toctree.yml b/hfdocs/source/_toctree.yml
index 3fa994b6..2d486058 100644
--- a/hfdocs/source/_toctree.yml
+++ b/hfdocs/source/_toctree.yml
@@ -1,6 +1,30 @@
 - sections: 
   - local: index
-    title: Pytorch Image Models (timm)
+    title: Home
+  - local: quickstart
+    title: Quickstart
+  - local: installation
+    title: Installation
+  title: Get started
+- sections:
+  - local: inference
+    title: Using Pretrained Models for Inference
+  - local: training_script
+    title: Training With The Official Training Script
+  - local: hf_hub
+    title: Share and Load Models from the Hugging Face Hub
+  title: Tutorials
+- sections:
+  - local: reference/models
+    title: Models
+  - local: reference/augmentation
+    title: Augmentation
+  - local: reference/data
+    title: Data
+  - local: reference/optimization
+    title: Optimization
+  title: Reference
+- sections:
   - local: models
     title: Model Summaries
   - local: results
@@ -145,5 +169,4 @@
         title: Wide ResNet
       - local: models/xception
         title: Xception
-  title: Get started
-
+  title: Legacy Docs
diff --git a/hfdocs/source/hf_hub.mdx b/hfdocs/source/hf_hub.mdx
new file mode 100644
index 00000000..e4f168b9
--- /dev/null
+++ b/hfdocs/source/hf_hub.mdx
@@ -0,0 +1,3 @@
+# Sharing and Loading Models From the Hugging Face Hub
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/index.mdx b/hfdocs/source/index.mdx
index 3733ae1e..58ec4261 100644
--- a/hfdocs/source/index.mdx
+++ b/hfdocs/source/index.mdx
@@ -2,6 +2,10 @@
 
 ## Welcome
 
+`timm` is a library containing SOTA computer vision models, layers, utilities, optimizers, schedulers, data-loaders, augmentations, and training/evaluation scripts.
+
+TODO - clean up, move code snippets to quickstart
+
 Welcome to the `timm` documentation, a lean set of docs that covers the basics of `timm`.
 
 For a more comprehensive set of docs (currently under development), please visit [timmdocs](http://timm.fast.ai) by [Aman Arora](https://github.com/amaarora).
diff --git a/hfdocs/source/inference.mdx b/hfdocs/source/inference.mdx
new file mode 100644
index 00000000..a31c31d5
--- /dev/null
+++ b/hfdocs/source/inference.mdx
@@ -0,0 +1,3 @@
+# Inference
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/installation.mdx b/hfdocs/source/installation.mdx
new file mode 100644
index 00000000..2ae52518
--- /dev/null
+++ b/hfdocs/source/installation.mdx
@@ -0,0 +1,3 @@
+# Installation
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/quickstart.mdx b/hfdocs/source/quickstart.mdx
new file mode 100644
index 00000000..e3aa86a2
--- /dev/null
+++ b/hfdocs/source/quickstart.mdx
@@ -0,0 +1,3 @@
+# Quickstart
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/reference/augmentation.mdx b/hfdocs/source/reference/augmentation.mdx
new file mode 100644
index 00000000..f9133aed
--- /dev/null
+++ b/hfdocs/source/reference/augmentation.mdx
@@ -0,0 +1,3 @@
+# Augmentations
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/reference/data.mdx b/hfdocs/source/reference/data.mdx
new file mode 100644
index 00000000..1d4f4310
--- /dev/null
+++ b/hfdocs/source/reference/data.mdx
@@ -0,0 +1,3 @@
+# Data
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/reference/models.mdx b/hfdocs/source/reference/models.mdx
new file mode 100644
index 00000000..80ae058a
--- /dev/null
+++ b/hfdocs/source/reference/models.mdx
@@ -0,0 +1,3 @@
+# Models
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/reference/optimization.mdx b/hfdocs/source/reference/optimization.mdx
new file mode 100644
index 00000000..f4b651c2
--- /dev/null
+++ b/hfdocs/source/reference/optimization.mdx
@@ -0,0 +1,3 @@
+# Optimization
+
+TODO
\ No newline at end of file
diff --git a/hfdocs/source/training_script.mdx b/hfdocs/source/training_script.mdx
new file mode 100644
index 00000000..66cce8ac
--- /dev/null
+++ b/hfdocs/source/training_script.mdx
@@ -0,0 +1,3 @@
+# Training Using the Official Training Script
+
+TODO
\ No newline at end of file