Skip to content

Commit 9f5bba9

Browse files
naterawnateraw
authored
Structure Hugging Face Docs (huggingface#1575)
* 🎨 structure docs * 🚧 wip docs * 📝 add installation doc * 📝 wip docs * 📝 wip docs * 📝 wip docs * 📝 wip docs * 📝 wip docs * 📝 add basic reference docs * 📝 remove augmentation from toctree * 👷 update pr doc builder to bugfix branch * 📝 wip docs * 🚧 wip * 👷 bump CI * 🚧 wip * 🚧 bump CI * 🚧 wip * 🚧 wip * 🚧 wip * 📝 add hf hub tutorial doc * 🔥 remove inference tut * 🚧 wip * 📝 wip docs * 📝 wip docs * 📝 update docs * 📝 move validation script doc up in order * 🎨 restructure to remove legacy docs * 📝 update index doc * 📝 update number of pretrained models * Update hfdocs/README.md * Update .github/workflows/build_pr_documentation.yml * Update build_pr_documentation.yml * bump * 📌 update gh action to use main branch * 🔥 remove comment
1 parent 960f5f9 commit 9f5bba9

16 files changed

+649
-881
lines changed

‎.github/workflows/build_pr_documentation.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ jobs:
1717
package_name: timm
1818
repo_owner: rwightman
1919
path_to_docs: pytorch-image-models/hfdocs/source
20+
version_tag_suffix: ""

‎hfdocs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Hugging Face Timm Docs
2+
3+
## Getting Started
4+
5+
```
6+
pip install git+https://github.com/huggingface/doc-builder.git@main#egg=hf-doc-builder
7+
pip install watchdog black
8+
```
9+
10+
## Preview the Docs Locally
11+
12+
```
13+
doc-builder preview timm hfdocs/source
14+
```

‎hfdocs/source/_toctree.yml

Lines changed: 153 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -1,149 +1,160 @@
11
- sections:
22
- local: index
3-
title: Pytorch Image Models (timm)
3+
title: Home
4+
- local: quickstart
5+
title: Quickstart
6+
- local: installation
7+
title: Installation
8+
title: Get started
9+
- sections:
10+
- local: feature_extraction
11+
title: Using Pretrained Models as Feature Extractors
12+
- local: training_script
13+
title: Training With The Official Training Script
14+
- local: hf_hub
15+
title: Share and Load Models from the 🤗 Hugging Face Hub
16+
title: Tutorials
17+
- sections:
418
- local: models
519
title: Model Summaries
620
- local: results
721
title: Results
8-
- local: scripts
9-
title: Scripts
10-
- local: training_hparam_examples
11-
title: Training Examples
12-
- local: feature_extraction
13-
title: Feature Extraction
14-
- local: changes
15-
title: Recent Changes
16-
- local: archived_changes
17-
title: Archived Changes
18-
- local: model_pages
19-
title: Model Pages
20-
isExpanded: false
21-
sections:
22-
- local: models/adversarial-inception-v3
23-
title: Adversarial Inception v3
24-
- local: models/advprop
25-
title: AdvProp (EfficientNet)
26-
- local: models/big-transfer
27-
title: Big Transfer (BiT)
28-
- local: models/csp-darknet
29-
title: CSP-DarkNet
30-
- local: models/csp-resnet
31-
title: CSP-ResNet
32-
- local: models/csp-resnext
33-
title: CSP-ResNeXt
34-
- local: models/densenet
35-
title: DenseNet
36-
- local: models/dla
37-
title: Deep Layer Aggregation
38-
- local: models/dpn
39-
title: Dual Path Network (DPN)
40-
- local: models/ecaresnet
41-
title: ECA-ResNet
42-
- local: models/efficientnet
43-
title: EfficientNet
44-
- local: models/efficientnet-pruned
45-
title: EfficientNet (Knapsack Pruned)
46-
- local: models/ensemble-adversarial
47-
title: Ensemble Adversarial Inception ResNet v2
48-
- local: models/ese-vovnet
49-
title: ESE-VoVNet
50-
- local: models/fbnet
51-
title: FBNet
52-
- local: models/gloun-inception-v3
53-
title: (Gluon) Inception v3
54-
- local: models/gloun-resnet
55-
title: (Gluon) ResNet
56-
- local: models/gloun-resnext
57-
title: (Gluon) ResNeXt
58-
- local: models/gloun-senet
59-
title: (Gluon) SENet
60-
- local: models/gloun-seresnext
61-
title: (Gluon) SE-ResNeXt
62-
- local: models/gloun-xception
63-
title: (Gluon) Xception
64-
- local: models/hrnet
65-
title: HRNet
66-
- local: models/ig-resnext
67-
title: Instagram ResNeXt WSL
68-
- local: models/inception-resnet-v2
69-
title: Inception ResNet v2
70-
- local: models/inception-v3
71-
title: Inception v3
72-
- local: models/inception-v4
73-
title: Inception v4
74-
- local: models/legacy-se-resnet
75-
title: (Legacy) SE-ResNet
76-
- local: models/legacy-se-resnext
77-
title: (Legacy) SE-ResNeXt
78-
- local: models/legacy-senet
79-
title: (Legacy) SENet
80-
- local: models/mixnet
81-
title: MixNet
82-
- local: models/mnasnet
83-
title: MnasNet
84-
- local: models/mobilenet-v2
85-
title: MobileNet v2
86-
- local: models/mobilenet-v3
87-
title: MobileNet v3
88-
- local: models/nasnet
89-
title: NASNet
90-
- local: models/noisy-student
91-
title: Noisy Student (EfficientNet)
92-
- local: models/pnasnet
93-
title: PNASNet
94-
- local: models/regnetx
95-
title: RegNetX
96-
- local: models/regnety
97-
title: RegNetY
98-
- local: models/res2net
99-
title: Res2Net
100-
- local: models/res2next
101-
title: Res2NeXt
102-
- local: models/resnest
103-
title: ResNeSt
104-
- local: models/resnet
105-
title: ResNet
106-
- local: models/resnet-d
107-
title: ResNet-D
108-
- local: models/resnext
109-
title: ResNeXt
110-
- local: models/rexnet
111-
title: RexNet
112-
- local: models/se-resnet
113-
title: SE-ResNet
114-
- local: models/selecsls
115-
title: SelecSLS
116-
- local: models/seresnext
117-
title: SE-ResNeXt
118-
- local: models/skresnet
119-
title: SK-ResNet
120-
- local: models/skresnext
121-
title: SK-ResNeXt
122-
- local: models/spnasnet
123-
title: SPNASNet
124-
- local: models/ssl-resnet
125-
title: SSL ResNet
126-
- local: models/swsl-resnet
127-
title: SWSL ResNet
128-
- local: models/swsl-resnext
129-
title: SWSL ResNeXt
130-
- local: models/tf-efficientnet
131-
title: (Tensorflow) EfficientNet
132-
- local: models/tf-efficientnet-condconv
133-
title: (Tensorflow) EfficientNet CondConv
134-
- local: models/tf-efficientnet-lite
135-
title: (Tensorflow) EfficientNet Lite
136-
- local: models/tf-inception-v3
137-
title: (Tensorflow) Inception v3
138-
- local: models/tf-mixnet
139-
title: (Tensorflow) MixNet
140-
- local: models/tf-mobilenet-v3
141-
title: (Tensorflow) MobileNet v3
142-
- local: models/tresnet
143-
title: TResNet
144-
- local: models/wide-resnet
145-
title: Wide ResNet
146-
- local: models/xception
147-
title: Xception
148-
title: Get started
22+
- local: models/adversarial-inception-v3
23+
title: Adversarial Inception v3
24+
- local: models/advprop
25+
title: AdvProp (EfficientNet)
26+
- local: models/big-transfer
27+
title: Big Transfer (BiT)
28+
- local: models/csp-darknet
29+
title: CSP-DarkNet
30+
- local: models/csp-resnet
31+
title: CSP-ResNet
32+
- local: models/csp-resnext
33+
title: CSP-ResNeXt
34+
- local: models/densenet
35+
title: DenseNet
36+
- local: models/dla
37+
title: Deep Layer Aggregation
38+
- local: models/dpn
39+
title: Dual Path Network (DPN)
40+
- local: models/ecaresnet
41+
title: ECA-ResNet
42+
- local: models/efficientnet
43+
title: EfficientNet
44+
- local: models/efficientnet-pruned
45+
title: EfficientNet (Knapsack Pruned)
46+
- local: models/ensemble-adversarial
47+
title: Ensemble Adversarial Inception ResNet v2
48+
- local: models/ese-vovnet
49+
title: ESE-VoVNet
50+
- local: models/fbnet
51+
title: FBNet
52+
- local: models/gloun-inception-v3
53+
title: (Gluon) Inception v3
54+
- local: models/gloun-resnet
55+
title: (Gluon) ResNet
56+
- local: models/gloun-resnext
57+
title: (Gluon) ResNeXt
58+
- local: models/gloun-senet
59+
title: (Gluon) SENet
60+
- local: models/gloun-seresnext
61+
title: (Gluon) SE-ResNeXt
62+
- local: models/gloun-xception
63+
title: (Gluon) Xception
64+
- local: models/hrnet
65+
title: HRNet
66+
- local: models/ig-resnext
67+
title: Instagram ResNeXt WSL
68+
- local: models/inception-resnet-v2
69+
title: Inception ResNet v2
70+
- local: models/inception-v3
71+
title: Inception v3
72+
- local: models/inception-v4
73+
title: Inception v4
74+
- local: models/legacy-se-resnet
75+
title: (Legacy) SE-ResNet
76+
- local: models/legacy-se-resnext
77+
title: (Legacy) SE-ResNeXt
78+
- local: models/legacy-senet
79+
title: (Legacy) SENet
80+
- local: models/mixnet
81+
title: MixNet
82+
- local: models/mnasnet
83+
title: MnasNet
84+
- local: models/mobilenet-v2
85+
title: MobileNet v2
86+
- local: models/mobilenet-v3
87+
title: MobileNet v3
88+
- local: models/nasnet
89+
title: NASNet
90+
- local: models/noisy-student
91+
title: Noisy Student (EfficientNet)
92+
- local: models/pnasnet
93+
title: PNASNet
94+
- local: models/regnetx
95+
title: RegNetX
96+
- local: models/regnety
97+
title: RegNetY
98+
- local: models/res2net
99+
title: Res2Net
100+
- local: models/res2next
101+
title: Res2NeXt
102+
- local: models/resnest
103+
title: ResNeSt
104+
- local: models/resnet
105+
title: ResNet
106+
- local: models/resnet-d
107+
title: ResNet-D
108+
- local: models/resnext
109+
title: ResNeXt
110+
- local: models/rexnet
111+
title: RexNet
112+
- local: models/se-resnet
113+
title: SE-ResNet
114+
- local: models/selecsls
115+
title: SelecSLS
116+
- local: models/seresnext
117+
title: SE-ResNeXt
118+
- local: models/skresnet
119+
title: SK-ResNet
120+
- local: models/skresnext
121+
title: SK-ResNeXt
122+
- local: models/spnasnet
123+
title: SPNASNet
124+
- local: models/ssl-resnet
125+
title: SSL ResNet
126+
- local: models/swsl-resnet
127+
title: SWSL ResNet
128+
- local: models/swsl-resnext
129+
title: SWSL ResNeXt
130+
- local: models/tf-efficientnet
131+
title: (Tensorflow) EfficientNet
132+
- local: models/tf-efficientnet-condconv
133+
title: (Tensorflow) EfficientNet CondConv
134+
- local: models/tf-efficientnet-lite
135+
title: (Tensorflow) EfficientNet Lite
136+
- local: models/tf-inception-v3
137+
title: (Tensorflow) Inception v3
138+
- local: models/tf-mixnet
139+
title: (Tensorflow) MixNet
140+
- local: models/tf-mobilenet-v3
141+
title: (Tensorflow) MobileNet v3
142+
- local: models/tresnet
143+
title: TResNet
144+
- local: models/wide-resnet
145+
title: Wide ResNet
146+
- local: models/xception
147+
title: Xception
148+
title: Model Pages
149+
isExpanded: false
150+
- sections:
151+
- local: reference/models
152+
title: Models
153+
- local: reference/data
154+
title: Data
155+
- local: reference/optimizers
156+
title: Optimizers
157+
- local: reference/schedulers
158+
title: Learning Rate Schedulers
159+
title: Reference
149160

0 commit comments

Comments
 (0)