Skip to content

Commit 2f041b8

Browse files
rwightmanrwightman
authored
Merge pull request #1473 from nateraw/hfdocs
Add Hugging Face Docs
2 parents bb49d02 + af0c644 commit 2f041b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+18421
-0
lines changed

‎.github/workflows/build_documentation.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Build documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- doc-builder*
8+
- v*-release
9+
10+
jobs:
11+
build:
12+
uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
13+
with:
14+
commit_sha: ${{ github.sha }}
15+
package: pytorch-image-models
16+
package_name: timm
17+
repo_owner: rwightman
18+
path_to_docs: pytorch-image-models/hfdocs/source
19+
secrets:
20+
token: ${{ secrets.HUGGINGFACE_PUSH }}

‎.github/workflows/build_pr_documentation.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Build PR Documentation
2+
3+
on:
4+
pull_request:
5+
6+
concurrency:
7+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
8+
cancel-in-progress: true
9+
10+
jobs:
11+
build:
12+
uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
13+
with:
14+
commit_sha: ${{ github.event.pull_request.head.sha }}
15+
pr_number: ${{ github.event.number }}
16+
package: pytorch-image-models
17+
package_name: timm
18+
repo_owner: rwightman
19+
path_to_docs: pytorch-image-models/hfdocs/source

‎.github/workflows/delete_doc_comment.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Delete dev documentation
2+
3+
on:
4+
pull_request:
5+
types: [ closed ]
6+
7+
8+
jobs:
9+
delete:
10+
uses: huggingface/doc-builder/.github/workflows/delete_doc_comment.yml@main
11+
with:
12+
pr_number: ${{ github.event.number }}
13+
package: timm

‎hfdocs/source/_conf.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
default_branch_name = "master"

‎hfdocs/source/_toctree.yml‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
- sections:
2+
- local: index
3+
title: Pytorch Image Models (timm)
4+
- local: models
5+
title: Model Summaries
6+
- local: results
7+
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
149+

0 commit comments

Comments
 (0)