Reference for hub_sdk/modules/projects.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/modules/projects.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.modules.projects.Projects
Bases: CRUDClient
A class representing a client for interacting with Projects through CRUD operations. This class extends the CRUDClient class and provides specific methods for working with Projects.
Attributes:
Name | Type | Description |
---|---|---|
hub_client | ProjectUpload | An instance of ProjectUpload used for interacting with model uploads. |
id | (str, None) | The unique identifier of the project, if available. |
data | dict | A dictionary to store project data. |
Note
The 'id' attribute is set during initialization and can be used to uniquely identify a project. The 'data' attribute is used to store project data fetched from the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_id | str | Project ID for retrieving data. | None |
headers | dict | A dictionary of HTTP headers to be included in API requests. | None |
Source code in hub_sdk/modules/projects.py
create_project
Creates a new project with the provided data and sets the project ID for the current instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_data | dict | A dictionary containing the data for creating the project. | required |
Returns:
Type | Description |
---|---|
None | The method does not return a value. |
Source code in hub_sdk/modules/projects.py
delete
Delete the project resource represented by this instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hard | bool | If True, perform a hard (permanent) delete. | False |
Note
The 'hard' parameter determines whether to perform a soft delete (default) or a hard delete. In a soft delete, the project might be marked as deleted but retained in the system. In a hard delete, the project is permanently removed from the system.
Returns:
Type | Description |
---|---|
Optional[Response] | Response object from the delete request, or None if delete fails. |
Source code in hub_sdk/modules/projects.py
get_data
Retrieves data for the current project instance.
If a valid project ID has been set, it sends a request to fetch the project data and stores it in the instance. If no project ID has been set, it logs an error message.
Returns:
Type | Description |
---|---|
None | The method does not return a value. |
Source code in hub_sdk/modules/projects.py
update
Update the project resource represented by this instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data | dict | The updated data for the project resource. | required |
Returns:
Type | Description |
---|---|
Optional[Response] | Response object from the update request, or None if update fails. |
Source code in hub_sdk/modules/projects.py
upload_image
Uploads an image file to the hub associated with this client.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file | str | The file path or URL of the image to be uploaded. | required |
Returns:
Type | Description |
---|---|
Optional[Response] | Response object from the uploaded image request, or None if upload fails. |
Source code in hub_sdk/modules/projects.py
hub_sdk.modules.projects.ProjectList
Bases: PaginatedList
Provides a paginated list interface for querying project resources from the server.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
page_size | int | The number of items to request per page. | None |
public | bool | Whether the items should be publicly accessible. | None |
headers | dict | Headers to be included in API requests. | None |