Reference for hub_sdk/base/server_clients.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/server_clients.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.base.server_clients.ModelUpload
Bases: APIClient
Source code in hub_sdk/base/server_clients.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
|
__init__(headers)
Initialize ModelUpload with API client configuration.
Source code in hub_sdk/base/server_clients.py
export(id, format)
Export a file for a specific entity.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The unique identifier of the entity to which the file is being exported. |
required |
format |
str
|
Path to the file to be Exported. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the export request, or None if it fails. |
Source code in hub_sdk/base/server_clients.py
predict(id, image, config)
Perform a prediction using the specified image and configuration.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
Unique identifier for the prediction request. |
required |
image |
str
|
Image path for prediction. |
required |
config |
dict
|
Configuration parameters for the prediction. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the predict request, or None if upload fails. |
Source code in hub_sdk/base/server_clients.py
upload_metrics(id, data)
Upload a file for a specific entity.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The unique identifier of the entity to which the file is being uploaded. |
required |
data |
dict
|
The metrics data to upload. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the upload_metrics request, or None if it fails. |
Source code in hub_sdk/base/server_clients.py
upload_model(id, epoch, weights, is_best=False, map=0.0, final=False)
Upload a model checkpoint to Ultralytics HUB.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
epoch |
int
|
The current training epoch. |
required |
weights |
str
|
Path to the model weights file. |
required |
is_best |
bool
|
Indicates if the current model is the best one so far. |
False
|
map |
float
|
Mean average precision of the model. |
0.0
|
final |
bool
|
Indicates if the model is the final model after training. |
False
|
Source code in hub_sdk/base/server_clients.py
hub_sdk.base.server_clients.ProjectUpload
Bases: APIClient
Source code in hub_sdk/base/server_clients.py
__init__(headers)
Initialize the class with the specified headers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
headers |
dict
|
The headers to use for API requests. |
required |
Source code in hub_sdk/base/server_clients.py
upload_image(id, file)
Upload a project file to the hub.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The ID of the dataset to upload. |
required |
file |
str
|
The path to the dataset file to upload. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the upload image request, or None if it fails. |
Source code in hub_sdk/base/server_clients.py
hub_sdk.base.server_clients.DatasetUpload
Bases: APIClient
Source code in hub_sdk/base/server_clients.py
__init__(headers)
Initialize the class with the specified headers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
headers |
dict
|
The headers to use for API requests. |
required |
Source code in hub_sdk/base/server_clients.py
upload_dataset(id, file)
Upload a dataset file to the hub.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The ID of the dataset to upload. |
required |
file |
str
|
The path to the dataset file to upload. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the upload dataset request, or None if it fails. |
Source code in hub_sdk/base/server_clients.py
hub_sdk.base.server_clients.is_colab()
Check if the current script is running inside a Google Colab notebook.
Returns:
Type | Description |
---|---|
bool
|
True if running inside a Colab notebook, False otherwise. |