🎨 structure docs

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
+```

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

hfdocs/source/hf_hub.mdx

@@ -0,0 +1,3 @@
+# Sharing and Loading Models From the Hugging Face Hub
+
+TODO

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).

hfdocs/source/inference.mdx

@@ -0,0 +1,3 @@
+# Inference
+
+TODO

hfdocs/source/installation.mdx

@@ -0,0 +1,3 @@
+# Installation
+
+TODO

hfdocs/source/quickstart.mdx

@@ -0,0 +1,3 @@
+# Quickstart
+
+TODO

hfdocs/source/reference/augmentation.mdx

@@ -0,0 +1,3 @@
+# Augmentations
+
+TODO

hfdocs/source/reference/data.mdx

@@ -0,0 +1,3 @@
+# Data
+
+TODO

hfdocs/source/reference/models.mdx

@@ -0,0 +1,3 @@
+# Models
+
+TODO

hfdocs/source/reference/optimization.mdx

@@ -0,0 +1,3 @@
+# Optimization
+
+TODO

hfdocs/source/training_script.mdx

@@ -0,0 +1,3 @@
+# Training Using the Official Training Script
+
+TODO