From 2f9f40130b51b83a24c880c0aa7ba14cdcdce893 Mon Sep 17 00:00:00 2001 From: nateraw Date: Mon, 5 Dec 2022 21:34:49 -0500 Subject: [PATCH] :memo: wip docs --- hfdocs/source/quickstart.mdx | 6 +++--- hfdocs/source/reference/data.mdx | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/hfdocs/source/quickstart.mdx b/hfdocs/source/quickstart.mdx index 2386766a..20771024 100644 --- a/hfdocs/source/quickstart.mdx +++ b/hfdocs/source/quickstart.mdx @@ -22,7 +22,7 @@ Here, we load the pretrained `mobilenetv3_large_100` model. ``` -**Note:** The returned PyTorch model is set to `train` mode by default, so you must call `.eval()` on it if you plan to use it for inference. + Note: The returned PyTorch model is set to train mode by default, so you must call .eval() on it if you plan to use it for inference. ## List Models with Pretrained Weights @@ -92,7 +92,7 @@ torch.Size([1, 960, 7, 7]) ## Image Augmentation -To transform images into valid inputs for a model, you can use `timm.data.create_transform`, providing the desired `input_size` that the model expects. +To transform images into valid inputs for a model, you can use [`timm.data.create_transform`], providing the desired `input_size` that the model expects. This will return a generic transform that uses reasonable defaults. @@ -125,7 +125,7 @@ To figure out which transformations were used for a given pretrained model, we c 'architecture': 'mobilenetv3_large_100'} ``` -We can then resolve only the data related configuration by using `timm.data.resolve_data_config`. +We can then resolve only the data related configuration by using [`timm.data.resolve_data_config`]. ```py >>> timm.data.resolve_data_config(model.pretrained_cfg) diff --git a/hfdocs/source/reference/data.mdx b/hfdocs/source/reference/data.mdx index 0b00c9e3..b5048739 100644 --- a/hfdocs/source/reference/data.mdx +++ b/hfdocs/source/reference/data.mdx @@ -5,3 +5,5 @@ [[autodoc]] timm.data.create_loader [[autodoc]] timm.data.create_transform + +[[autodoc]] timm.data.resolve_data_config \ No newline at end of file