From d0a067705f550b3637264837da42a3d399693416 Mon Sep 17 00:00:00 2001 From: nateraw Date: Mon, 5 Dec 2022 17:19:11 -0500 Subject: [PATCH] :memo: add basic reference docs --- hfdocs/source/reference/augmentation.mdx | 3 --- hfdocs/source/reference/data.mdx | 6 +++++- hfdocs/source/reference/models.mdx | 4 +++- hfdocs/source/reference/optimization.mdx | 11 ++++++++++- 4 files changed, 18 insertions(+), 6 deletions(-) delete mode 100644 hfdocs/source/reference/augmentation.mdx diff --git a/hfdocs/source/reference/augmentation.mdx b/hfdocs/source/reference/augmentation.mdx deleted file mode 100644 index f9133aed..00000000 --- a/hfdocs/source/reference/augmentation.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Augmentations - -TODO \ No newline at end of file diff --git a/hfdocs/source/reference/data.mdx b/hfdocs/source/reference/data.mdx index 1d4f4310..bf635037 100644 --- a/hfdocs/source/reference/data.mdx +++ b/hfdocs/source/reference/data.mdx @@ -1,3 +1,7 @@ # Data -TODO \ No newline at end of file +[[autodoc]] timm.data.create_dataset + +[[autodoc]] timm.data.create_loader + +[[autodoc]] timm.data.create_transform \ No newline at end of file diff --git a/hfdocs/source/reference/models.mdx b/hfdocs/source/reference/models.mdx index 80ae058a..31bb3c27 100644 --- a/hfdocs/source/reference/models.mdx +++ b/hfdocs/source/reference/models.mdx @@ -1,3 +1,5 @@ # Models -TODO \ No newline at end of file +[[autodoc]] timm.create_model + +[[autodoc]] timm.list_models diff --git a/hfdocs/source/reference/optimization.mdx b/hfdocs/source/reference/optimization.mdx index f4b651c2..6f619114 100644 --- a/hfdocs/source/reference/optimization.mdx +++ b/hfdocs/source/reference/optimization.mdx @@ -1,3 +1,12 @@ # Optimization -TODO \ No newline at end of file +## 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