─░├žeri─če ge├ž

Referans i├žin hub_sdk/modules/projects.py

Not

Bu dosya https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/modules/projects .py adresinde mevcuttur. Bir sorun tespit ederseniz, l├╝tfen bir ├çekme ─░ste─či ­čŤá´ŞĆ ile katk─▒da bulunarak d├╝zeltmeye yard─▒mc─▒ olun. Te┼čekk├╝rler ­čÖĆ!



hub_sdk.modules.projects.Projects

├ťsler: CRUDClient

CRUD i┼člemleri arac─▒l─▒─č─▒yla Projelerle etkile┼čim i├žin bir istemciyi temsil eden bir s─▒n─▒f. Bu s─▒n─▒f a┼ča─č─▒dakileri geni┼čletir CRUDClient s─▒n─▒f─▒ ve Projeler ile ├žal─▒┼čmak i├žin ├Âzel y├Ântemler sa─člar.

Nitelikler:

─░sim Tip A├ž─▒klama
hub_client ProjectUpload

Model y├╝klemeleriyle etkile┼čim i├žin kullan─▒lan bir ProjectUpload ├Ârne─či.

id (str, None)

Varsa, projenin benzersiz tan─▒mlay─▒c─▒s─▒.

data dict

Proje verilerini depolamak i├žin bir s├Âzl├╝k.

Not

'id' ├Âzniteli─či ba┼člatma s─▒ras─▒nda ayarlan─▒r ve bir projeyi benzersiz bir ┼čekilde tan─▒mlamak i├žin kullan─▒labilir. 'data' ├Âzniteli─či, API'den al─▒nan proje verilerini saklamak i├žin kullan─▒l─▒r.

Kaynak kodu 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 not self.id:
            self.logger.error("No project id has been set. Update the project id or create a project.")
            return

        try:
            response = super().read(self.id)

            if response is None:
                self.logger.error(f"Received no response from the server for project ID: {self.id}")
                return

            # Check if the response has a .json() method (it should if it's a response object)
            if not hasattr(response, "json"):
                self.logger.error(f"Invalid response object received for project ID: {self.id}")
                return

            resp_data = response.json()
            if resp_data is None:
                self.logger.error(f"No data received in the response for project ID: {self.id}")
                return

            self.data = resp_data.get("data", {})
            self.logger.debug(f"Project data retrieved for id ID: {self.id}")

        except Exception as e:
            self.logger.error(f"An error occurred while retrieving data for project ID: {self.id}, {e}")

    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 i┼člemleri arac─▒l─▒─č─▒yla proje verileriyle etkile┼čim i├žin bir Projects nesnesini ba┼člat─▒n.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
project_id str

Verileri almak i├žin Proje Kimli─či.

None
headers dict

API isteklerine dahil edilecek HTTP ├╝stbilgileri s├Âzl├╝─č├╝.

None
Kaynak kodu 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)

Sa─članan verilerle yeni bir proje olu┼čturur ve ge├žerli ├Ârnek i├žin proje kimli─čini ayarlar.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
project_data dict

Projeyi olu┼čturmak i├žin gerekli verileri i├žeren bir s├Âzl├╝k.

gerekli

─░ade:

Tip A├ž─▒klama
None

Y├Ântem bir de─čer d├Ând├╝rmez.

Kaynak kodu 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)

Bu ├Ârnek taraf─▒ndan temsil edilen proje kayna─č─▒n─▒ silin.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
hard bool

Do─čru ise, sert (kal─▒c─▒) bir silme i┼člemi ger├žekle┼čtirin.

False
Not

'hard' parametresi yumu┼čak silme (varsay─▒lan) veya sert silme i┼člemlerinden hangisinin ger├žekle┼čtirilece─čini belirler. Yumu┼čak silme i┼čleminde, proje silinmi┼č olarak i┼čaretlenebilir ancak sistemde tutulabilir. Sert silme i┼čleminde proje sistemden kal─▒c─▒ olarak kald─▒r─▒l─▒r.

─░ade:

Tip A├ž─▒klama
Optional[Response]

Silme iste─činden gelen yan─▒t nesnesi veya silme ba┼čar─▒s─▒z olursa Yok.

Kaynak kodu 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()

Ge├žerli proje ├Ârne─či i├žin verileri al─▒r.

Ge├žerli bir proje kimli─či ayarlanm─▒┼čsa, proje verilerini almak i├žin bir istek g├Ânderir ve bunlar─▒ ├Ârnekte depolar. Herhangi bir proje kimli─či ayarlanmam─▒┼čsa, bir hata mesaj─▒ g├╝nl├╝─če kaydeder.

─░ade:

Tip A├ž─▒klama
None

Y├Ântem bir de─čer d├Ând├╝rmez.

Kaynak kodu 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 not self.id:
        self.logger.error("No project id has been set. Update the project id or create a project.")
        return

    try:
        response = super().read(self.id)

        if response is None:
            self.logger.error(f"Received no response from the server for project ID: {self.id}")
            return

        # Check if the response has a .json() method (it should if it's a response object)
        if not hasattr(response, "json"):
            self.logger.error(f"Invalid response object received for project ID: {self.id}")
            return

        resp_data = response.json()
        if resp_data is None:
            self.logger.error(f"No data received in the response for project ID: {self.id}")
            return

        self.data = resp_data.get("data", {})
        self.logger.debug(f"Project data retrieved for id ID: {self.id}")

    except Exception as e:
        self.logger.error(f"An error occurred while retrieving data for project ID: {self.id}, {e}")

update(data)

Bu ├Ârnek taraf─▒ndan temsil edilen proje kayna─č─▒n─▒ g├╝ncelleyin.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
data dict

Proje kayna─č─▒ i├žin g├╝ncellenmi┼č veriler.

gerekli

─░ade:

Tip A├ž─▒klama
Optional[Response]

G├╝ncelleme iste─činden gelen yan─▒t nesnesi veya g├╝ncelleme ba┼čar─▒s─▒z olursa Yok.

Kaynak kodu 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)

Bu istemciyle ili┼čkili hub'a bir g├Âr├╝nt├╝ dosyas─▒ y├╝kler.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
file str

Y├╝klenecek g├Âr├╝nt├╝n├╝n dosya yolu veya URL'si.

gerekli

─░ade:

Tip A├ž─▒klama
Optional[Response]

Y├╝klenen resim iste─činden gelen yan─▒t nesnesi veya y├╝kleme ba┼čar─▒s─▒z olursa Yok.

Kaynak kodu 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

├ťsler: PaginatedList

Kaynak kodu 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"
        super().__init__(base_endpoint, "project", page_size, public, headers)

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

Bir ProjectList ├Ârne─čini ba┼člat─▒n.

Parametreler:

─░sim Tip A├ž─▒klama Varsay─▒lan
page_size int

Sayfa ba┼č─▒na talep edilecek ├Â─če say─▒s─▒.

None
public bool

├ľ─čelerin kamu eri┼čimine a├ž─▒k olup olmamas─▒.

None
headers dict

API isteklerine dahil edilecek ba┼čl─▒klar.

None
Kaynak kodu 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"
    super().__init__(base_endpoint, "project", page_size, public, headers)