Roboflow
RoboflowModelRegistry
¶
Bases: ModelRegistry
A Roboflow-specific model registry which gets the model type using the model id, then returns a model class based on the model type.
Source code in inference/core/registries/roboflow.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
get_model(model_id, api_key)
¶
Returns the model class based on the given model id and API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The ID of the model to be retrieved. |
required |
api_key
|
str
|
The API key used to authenticate. |
required |
Returns:
Name | Type | Description |
---|---|---|
Model |
Model
|
The model class corresponding to the given model ID and type. |
Raises:
Type | Description |
---|---|
ModelNotRecognisedError
|
If the model type is not supported or found. |
Source code in inference/core/registries/roboflow.py
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
get_model_type(model_id, api_key=None)
¶
Retrieves the model type based on the given model ID and API key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The ID of the model. |
required |
api_key
|
str
|
The API key used to authenticate. |
None
|
Returns:
Name | Type | Description |
---|---|---|
tuple |
Tuple[TaskType, ModelType]
|
The project task type and the model type. |
Raises:
Type | Description |
---|---|
WorkspaceLoadError
|
If the workspace could not be loaded or if the API key is invalid. |
DatasetLoadError
|
If the dataset could not be loaded due to invalid ID, workspace ID or version ID. |
MissingDefaultModelError
|
If default model is not configured and API does not provide this info |
MalformedRoboflowAPIResponseError
|
Roboflow API responds in invalid format. |
Source code in inference/core/registries/roboflow.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
|