Skip to content

Commit 40601d1

Browse files
docs: update model id readme
1 parent 5720f17 commit 40601d1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

tests/model_identification/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pytest -v tests/test_model_probe/test_identification.py
2323

2424
## Stripped Model Files
2525

26-
Invoke abstracts the loading of a model's state dict and metadata in a class called [`ModelOnDisk`](../invokeai/backend/model_manager/model_on_disk.py). This class loads real model weights. We use it to inspect models and identify them.
26+
Invoke abstracts the loading of a model's state dict and metadata in a class called [`ModelOnDisk`](../../invokeai/backend/model_manager/model_on_disk.py). This class loads real model weights. We use it to inspect models and identify them.
2727

2828
For testing purposes, we create a stripped-down version of model weights that contain only the model structure and metadata for each key, without the actual tensor data. The state dict structure is typically all we need to identify models; the tensors themselves are not needed. This allows us to store test cases in the repo without adding many gigabytes of data.
2929

@@ -85,7 +85,7 @@ A string indicating the source of the model (e.g. a Hugging Face repo ID or URL)
8585
- Example HF Repo ID: `"RunDiffusion/Juggernaut-XL-v9"`
8686
- Example URL: `"https://huggingface.co/XpucT/Deliberate/resolve/main/Deliberate_v5.safetensors"`
8787

88-
### `"file_name"`
88+
#### `"file_name"`
8989

9090
If the model is a single file (e.g. a `.safetensors` file), this is the name of that file. The test suite will look for this file in the test case directory.
9191

@@ -95,7 +95,7 @@ If the model is multi-file (e.g. diffusers-style), omit this key or set it to a
9595

9696
> The `strip_model.py` script will automatically fill this field in for single-file models.
9797
98-
### `"expected_config_attrs"`
98+
#### `"expected_config_attrs"`
9999

100100
This field is a dict of expected configuration attributes for the model. It is required for all test cases.
101101

@@ -112,7 +112,7 @@ Depending on the kind of model, these additional keys may be useful:
112112
- `"prediction_type"`: The prediction type used by the model. This is the value of the `SchedulerPredictionType` enum.
113113
- `"variant"`: The variant of the model, if applicable. This is the value of the `ModelVariantType` enum.
114114

115-
To see all possible values for these enums, check out their definitions in [`invokeai/backend/model_manager/taxonomy.py`](../invokeai/backend/model_manager/taxonomy.py).
115+
To see all possible values for these enums, check out their definitions in [`invokeai/backend/model_manager/taxonomy.py`](../../invokeai/backend/model_manager/taxonomy.py).
116116

117117
For example, for a SD1.5 main (pipeline) inpainting model in diffusers format, you might have:
118118

@@ -128,11 +128,11 @@ For example, for a SD1.5 main (pipeline) inpainting model in diffusers format, y
128128
}
129129
```
130130

131-
### `"notes"`
131+
#### `"notes"`
132132

133133
This is an optional string field where you can add any notes or comments about the test case. It can be useful for providing context or explaining any special considerations.
134134

135-
### `"override_fields"`
135+
#### `"override_fields"`
136136

137137
In some rare cases, we may need to provide additional hints to the identification system to help it identify the model correctly.
138138

0 commit comments

Comments
 (0)