コンテンツへスキップ

参考 hub_sdk/modules/projects.py

備考

このファイルはhttps://github.com/ultralytics/hub-sdk/blob/main/ hub_sdk/modules/projects .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございます🙏!



hub_sdk.modules.projects.Projects

ベース: CRUDClient

CRUD 操作によってプロジェクトとやり取りするクライアントを表すクラス。このクラスは クラスを拡張し、Projects を操作するための特定のメソッドを提供します。

属性:

名称 タイプ 説明
hub_client ProjectUpload

モデルのアップロードに使用されるProjectUploadのインスタンス。

id (str, None)

プロジェクトの一意な識別子。

data dict

プロジェクトのデータを格納する辞書。

備考

id' 属性は初期化時に設定され、プロジェクトを一意に識別するために使用されます。 data' 属性は、APIから取得したプロジェクト・データを保存するために使用します。

ソースコード hub_sdk/modules/projects.py
class Projects(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:
        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.
    """

    def __init__(self, project_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None):
        """
        Initialize a Projects object for interacting with project data via CRUD operations.

        Args:
            project_id (str, optional): Project ID for retrieving data.
            headers (dict, optional): A dictionary of HTTP headers to be included in API requests.
        """
        super().__init__("projects", "project", headers)
        self.hub_client = ProjectUpload(headers)
        self.id = project_id
        self.data = {}
        if project_id:
            self.get_data()

    def get_data(self) -> None:
        """
        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:
            (None): The method does not return a value.
        """
        if self.id:
            resp = super().read(self.id).json()
            self.data = resp.get("data", {})
            self.logger.debug("Project id is %s", self.id)
        else:
            self.logger.error("No project id has been set. Update the project id or create a project.")

    def create_project(self, project_data: dict) -> None:
        """
        Creates a new project with the provided data and sets the project ID for the current instance.

        Args:
            project_data (dict): A dictionary containing the data for creating the project.

        Returns:
            (None): The method does not return a value.
        """
        resp = super().create(project_data).json()
        self.id = resp.get("data", {}).get("id")
        self.get_data()

    def delete(self, hard: Optional[bool] = False) -> Optional[Response]:
        """
        Delete the project resource represented by this instance.

        Args:
            hard (bool, optional): If True, perform a hard (permanent) delete.

        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:
            (Optional[Response]): Response object from the delete request, or None if delete fails.
        """
        return super().delete(self.id, hard)

    def update(self, data: dict) -> Optional[Response]:
        """
        Update the project resource represented by this instance.

        Args:
            data (dict): The updated data for the project resource.

        Returns:
            (Optional[Response]): Response object from the update request, or None if update fails.
        """
        return super().update(self.id, data)

    def upload_image(self, file: str) -> Optional[Response]:
        """
        Uploads an image file to the hub associated with this client.

        Args:
            file (str): The file path or URL of the image to be uploaded.

        Returns:
            (Optional[Response]): Response object from the uploaded image request, or None if upload fails.
        """
        return self.hub_client.upload_image(self.id, file)  # response

__init__(project_id=None, headers=None)

CRUD操作によってプロジェクト・データを操作するためのProjectsオブジェクトを初期化します。

パラメーター

名称 タイプ 説明 デフォルト
project_id str

データを検索するためのプロジェクトID。

None
headers dict

APIリクエストに含まれるHTTPヘッダーの辞書。

None
ソースコード hub_sdk/modules/projects.py
def __init__(self, project_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None):
    """
    Initialize a Projects object for interacting with project data via CRUD operations.

    Args:
        project_id (str, optional): Project ID for retrieving data.
        headers (dict, optional): A dictionary of HTTP headers to be included in API requests.
    """
    super().__init__("projects", "project", headers)
    self.hub_client = ProjectUpload(headers)
    self.id = project_id
    self.data = {}
    if project_id:
        self.get_data()

create_project(project_data)

提供されたデータで新しいプロジェクトを作成し、現在のインスタンスのプロジェクトIDを設定します。

パラメーター

名称 タイプ 説明 デフォルト
project_data dict

プロジェクトを作成するためのデータを含む辞書。

必須

リターンズ

タイプ 説明
None

メソッドは値を返さない。

ソースコード hub_sdk/modules/projects.py
def create_project(self, project_data: dict) -> None:
    """
    Creates a new project with the provided data and sets the project ID for the current instance.

    Args:
        project_data (dict): A dictionary containing the data for creating the project.

    Returns:
        (None): The method does not return a value.
    """
    resp = super().create(project_data).json()
    self.id = resp.get("data", {}).get("id")
    self.get_data()

delete(hard=False)

このインスタンスで表されるプロジェクトリソースを削除します。

パラメーター

名称 タイプ 説明 デフォルト
hard bool

Trueの場合、ハード(永久)削除を行う。

False
備考

hard' パラメーターは、ソフト削除(デフォルト)かハード削除かを決定します。 ソフト削除では、プロジェクトは削除されたものとしてマークされますが、システムには残ります。 ハード削除では、プロジェクトはシステムから永久に削除されます。

リターンズ

タイプ 説明
Optional[Response]

削除に失敗した場合は None。

ソースコード hub_sdk/modules/projects.py
def delete(self, hard: Optional[bool] = False) -> Optional[Response]:
    """
    Delete the project resource represented by this instance.

    Args:
        hard (bool, optional): If True, perform a hard (permanent) delete.

    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:
        (Optional[Response]): Response object from the delete request, or None if delete fails.
    """
    return super().delete(self.id, hard)

get_data()

現在のプロジェクト・インスタンスのデータを取得します。

有効なプロジェクトIDが設定されていれば、プロジェクト・データを取得するリクエストを送信し、インスタンスに格納します。 プロジェクトIDが設定されていない場合は、エラー・メッセージが記録されます。

リターンズ

タイプ 説明
None

メソッドは値を返さない。

ソースコード hub_sdk/modules/projects.py
def get_data(self) -> None:
    """
    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:
        (None): The method does not return a value.
    """
    if self.id:
        resp = super().read(self.id).json()
        self.data = resp.get("data", {})
        self.logger.debug("Project id is %s", self.id)
    else:
        self.logger.error("No project id has been set. Update the project id or create a project.")

update(data)

このインスタンスが表すプロジェクト・リソースを更新する。

パラメーター

名称 タイプ 説明 デフォルト
data dict

プロジェクトリソースの更新データ。

必須

リターンズ

タイプ 説明
Optional[Response]

更新リクエストのレスポンスオブジェクト。更新に失敗した場合は None。

ソースコード hub_sdk/modules/projects.py
def update(self, data: dict) -> Optional[Response]:
    """
    Update the project resource represented by this instance.

    Args:
        data (dict): The updated data for the project resource.

    Returns:
        (Optional[Response]): Response object from the update request, or None if update fails.
    """
    return super().update(self.id, data)

upload_image(file)

このクライアントに関連付けられているhub に画像ファイルをアップロードします。

パラメーター

名称 タイプ 説明 デフォルト
file str

アップロードする画像のファイルパスまたはURL。

必須

リターンズ

タイプ 説明
Optional[Response]

アップロードされた画像リクエストのレスポンスオブジェクト。

ソースコード hub_sdk/modules/projects.py
def upload_image(self, file: str) -> Optional[Response]:
    """
    Uploads an image file to the hub associated with this client.

    Args:
        file (str): The file path or URL of the image to be uploaded.

    Returns:
        (Optional[Response]): Response object from the uploaded image request, or None if upload fails.
    """
    return self.hub_client.upload_image(self.id, file)  # response



hub_sdk.modules.projects.ProjectList

ベース: PaginatedList

ソースコード hub_sdk/modules/projects.py
class ProjectList(PaginatedList):
    def __init__(self, page_size: int = None, public: bool = None, headers: dict = None):
        """
        Initialize a ProjectList instance.

        Args:
            page_size (int, optional): The number of items to request per page.
            public (bool, optional): Whether the items should be publicly accessible.
            headers (dict, optional): Headers to be included in API requests.
        """
        base_endpoint = "projects"
        if public:
            base_endpoint = f"public/{base_endpoint}"
        super().__init__(base_endpoint, "project", page_size, headers)

__init__(page_size=None, public=None, headers=None)

ProjectList インスタンスを初期化します。

パラメーター

名称 タイプ 説明 デフォルト
page_size int

ページあたりのリクエスト項目数。

None
public bool

一般公開すべきかどうか。

None
headers dict

API リクエストに含めるヘッダー。

None
ソースコード hub_sdk/modules/projects.py
def __init__(self, page_size: int = None, public: bool = None, headers: dict = None):
    """
    Initialize a ProjectList instance.

    Args:
        page_size (int, optional): The number of items to request per page.
        public (bool, optional): Whether the items should be publicly accessible.
        headers (dict, optional): Headers to be included in API requests.
    """
    base_endpoint = "projects"
    if public:
        base_endpoint = f"public/{base_endpoint}"
    super().__init__(base_endpoint, "project", page_size, headers)