📝 add basic reference docs

3 years ago · d0a067705f
parent 101a7ced95
commit d0a067705f
4 changed files with 18 additions and 6 deletions
--- a/hfdocs/source/reference/augmentation.mdx
+++ b/hfdocs/source/reference/augmentation.mdx
@ -1,3 +0,0 @@
-# Augmentations
-
-TODO
--- a/hfdocs/source/reference/data.mdx
+++ b/hfdocs/source/reference/data.mdx
@ -1,3 +1,7 @@
 # Data

-TODO
+[[autodoc]] timm.data.create_dataset
+
+[[autodoc]] timm.data.create_loader
+
+[[autodoc]] timm.data.create_transform
--- a/hfdocs/source/reference/models.mdx
+++ b/hfdocs/source/reference/models.mdx
@ -1,3 +1,5 @@
 # Models

-TODO
+[[autodoc]] timm.create_model
+
+[[autodoc]] timm.list_models
--- a/hfdocs/source/reference/optimization.mdx
+++ b/hfdocs/source/reference/optimization.mdx
@ -1,3 +1,12 @@
 # Optimization

-TODO
+## Optimizers
+
+[[autodoc]] timm.optim.optim_factory.create_optimizer
+
+## Schedulers
+
+[[autodoc]] timm.scheduler.cosine_lr.CosineLRScheduler
+[[autodoc]] timm.scheduler.step_lr.StepLRScheduler
+[[autodoc]] timm.scheduler.tanh_lr.TanhLRScheduler
+[[autodoc]] timm.scheduler.plateau_lr.PlateauLRScheduler