सामग्री पर जाएं

के लिए संदर्भ hub_sdk/modules/projects.py

नोट

यह फ़ाइल यहाँ उपलब्ध है https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/modules/projects.py. यदि आप कोई समस्या देखते हैं तो कृपया पुल अनुरोध का योगदान करके इसे ठीक करने में मदद करें 🛠️। 🙏 धन्यवाद !



hub_sdk.modules.projects.Projects

का रूप: CRUDClient

सीआरयूडी संचालन के माध्यम से परियोजनाओं के साथ बातचीत करने के लिए ग्राहक का प्रतिनिधित्व करने वाला एक वर्ग। यह वर्ग CRUDClient क्लास और प्रोजेक्ट्स के साथ काम करने के लिए विशिष्ट तरीके प्रदान करता है।

विशेषताएँ:

नाम प्रकार या क़िस्‍म
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 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 कार्रवाइयों के माध्यम से प्रोजेक्ट डेटा के साथ सहभागिता करने के लिए प्रोजेक्ट ऑब्जेक्ट प्रारंभ करें.

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
project_id str

डेटा पुनर्प्राप्त करने के लिए प्रोजेक्ट आईडी।

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)

प्रदान किए गए डेटा के साथ एक नया प्रोजेक्ट बनाता है और वर्तमान उदाहरण के लिए प्रोजेक्ट आईडी सेट करता है।

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
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

यदि सही है, तो एक कठिन (स्थायी) हटाएं निष्पादित करें।

False
नोट

'हार्ड' पैरामीटर निर्धारित करता है कि सॉफ्ट डिलीट (डिफ़ॉल्ट) करना है या हार्ड डिलीट करना है। एक नरम हटाने में, प्रोजेक्ट को हटाए गए के रूप में चिह्नित किया जा सकता है लेकिन सिस्टम में बनाए रखा जा सकता है। हार्ड डिलीट में, प्रोजेक्ट को सिस्टम से स्थायी रूप से हटा दिया जाता है।

देता:

प्रकार या क़िस्‍म
Optional[Response]

हटाने के अनुरोध से प्रतिक्रिया ऑब्जेक्ट, या कोई नहीं अगर हटाना विफल हो जाता है।

में स्रोत कोड 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 सेट नहीं किया गया है, तो यह एक त्रुटि संदेश लॉग करता है.

देता:

प्रकार या क़िस्‍म
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 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)

इस आवृत्ति द्वारा प्रस्तुत प्रोजेक्ट संसाधन का अद्यतन करें।

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
data dict

प्रोजेक्ट संसाधन के लिए अद्यतन किया गया डेटा.

आवश्यक

देता:

प्रकार या क़िस्‍म
Optional[Response]

अद्यतन अनुरोध से प्रतिसाद ऑब्जेक्ट, या कोई नहीं यदि अद्यतन विफल रहता है।

में स्रोत कोड 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)

इस क्लाइंट से जुड़े हब पर एक छवि फ़ाइल अपलोड करता है।

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
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"
        super().__init__(base_endpoint, "project", page_size, public, headers)

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

ProjectList आवृत्ति प्रारंभ करें.

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
page_size int

प्रति पृष्ठ अनुरोध करने के लिए आइटम की संख्या.

None
public bool

क्या आइटम सार्वजनिक रूप से सुलभ होने चाहिए।

None
headers dict

एपीआई अनुरोधों में शामिल किए जाने वाले शीर्षलेख।

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