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

के लिए संदर्भ ultralytics/hub/__init__.py

नोट

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



ultralytics.hub.login(api_key=None, save=True)

में लॉग इन करें Ultralytics HUB प्रदान की गई एपीआई कुंजी का उपयोग करके एपीआई।

सत्र संग्रहीत नहीं है; सहेजी गई सेटिंग्स का उपयोग करके आवश्यक होने पर एक नया सत्र बनाया जाता है या HUB_API_KEY पर्यावरण चर यदि सफलतापूर्वक प्रमाणित किया गया है।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
api_key str

प्रमाणीकरण के लिए उपयोग करने के लिए एपीआई कुंजी। यदि प्रदान नहीं किया गया है, तो इसे सेटिंग्स से पुनर्प्राप्त किया जाएगा या HUB_API_KEY पर्यावरण चर।

None
save bool

प्रमाणीकरण सफल होने पर एपीआई कुंजी को सेटिंग्स में सहेजना है या नहीं।

True

देता:

प्रकार विवरण: __________
bool

यदि प्रमाणीकरण सफल होता है तो सत्य, अन्यथा असत्य।

में स्रोत कोड ultralytics/hub/__init__.py
11बांग्लादेश 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36373839 404142434445464748495051 52
def login(api_key: str = None, save=True) -> bool:
    """
    Log in to the Ultralytics HUB API using the provided API key.

    The session is not stored; a new session is created when needed using the saved SETTINGS or the HUB_API_KEY
    environment variable if successfully authenticated.

    Args:
        api_key (str, optional): API key to use for authentication.
            If not provided, it will be retrieved from SETTINGS or HUB_API_KEY environment variable.
        save (bool, optional): Whether to save the API key to SETTINGS if authentication is successful.

    Returns:
        (bool): True if authentication is successful, False otherwise.
    """
    checks.check_requirements("hub-sdk>=0.0.2")
    from hub_sdk import HUBClient

    api_key_url = f"{HUB_WEB_ROOT}/settings?tab=api+keys"  # set the redirect URL
    saved_key = SETTINGS.get("api_key")
    active_key = api_key or saved_key
    credentials = {"api_key": active_key} if active_key and active_key != "" else None  # set credentials

    client = HUBClient(credentials)  # initialize HUBClient

    if client.authenticated:
        # Successfully authenticated with HUB

        if save and client.api_key != saved_key:
            SETTINGS.update({"api_key": client.api_key})  # update settings with valid API key

        # Set message based on whether key was provided or retrieved from settings
        log_message = (
            "New authentication successful ✅" if client.api_key == api_key or not credentials else "Authenticated ✅"
        )
        LOGGER.info(f"{PREFIX}{log_message}")

        return True
    else:
        # Failed to authenticate with HUB
        LOGGER.info(f"{PREFIX}Retrieve API key from {api_key_url}")
        return False



ultralytics.hub.logout()

लॉग आउट करें Ultralytics HUB सेटिंग्स फ़ाइल से एपीआई कुंजी को हटाकर। फिर से लॉग इन करने के लिए, 'yolo hub लॉगिन'।

उदाहरण
from ultralytics import hub

hub.logout()
में स्रोत कोड ultralytics/hub/__init__.py
def logout():
    """
    Log out of Ultralytics HUB by removing the API key from the settings file. To log in again, use 'yolo hub login'.

    Example:
        ```python
        from ultralytics import hub

        hub.logout()
        ```
    """
    SETTINGS["api_key"] = ""
    SETTINGS.save()
    LOGGER.info(f"{PREFIX}logged out ✅. To log in again, use 'yolo hub login'.")



ultralytics.hub.reset_model(model_id='')

एक प्रशिक्षित मॉडल को अप्रशिक्षित स्थिति में रीसेट करें।

में स्रोत कोड ultralytics/hub/__init__.py
def reset_model(model_id=""):
    """Reset a trained model to an untrained state."""
    r = requests.post(f"{HUB_API_ROOT}/model-reset", json={"modelId": model_id}, headers={"x-api-key": Auth().api_key})
    if r.status_code == 200:
        LOGGER.info(f"{PREFIX}Model reset successfully")
        return
    LOGGER.warning(f"{PREFIX}Model reset failure {r.status_code} {r.reason}")



ultralytics.hub.export_fmts_hub()

की एक सूची देता है HUB-समर्थित निर्यात प्रारूप।

में स्रोत कोड ultralytics/hub/__init__.py
def export_fmts_hub():
    """Returns a list of HUB-supported export formats."""
    from ultralytics.engine.exporter import export_formats

    return list(export_formats()["Argument"][1:]) + ["ultralytics_tflite", "ultralytics_coreml"]



ultralytics.hub.export_model(model_id='', format='torchscript')

सभी प्रारूपों के लिए एक मॉडल निर्यात करें।

में स्रोत कोड ultralytics/hub/__init__.py
def export_model(model_id="", format="torchscript"):
    """Export a model to all formats."""
    assert format in export_fmts_hub(), f"Unsupported export format '{format}', valid formats are {export_fmts_hub()}"
    r = requests.post(
        f"{HUB_API_ROOT}/v1/models/{model_id}/export", json={"format": format}, headers={"x-api-key": Auth().api_key}
    )
    assert r.status_code == 200, f"{PREFIX}{format} export failure {r.status_code} {r.reason}"
    LOGGER.info(f"{PREFIX}{format} export started ✅")



ultralytics.hub.get_export(model_id='', format='torchscript')

डाउनलोड URL के साथ एक निर्यात मॉडल शब्दकोश प्राप्त करें।

में स्रोत कोड ultralytics/hub/__init__.py
 97 98 99  100 101 102 103 104 105 106
def get_export(model_id="", format="torchscript"):
    """Get an exported model dictionary with download URL."""
    assert format in export_fmts_hub(), f"Unsupported export format '{format}', valid formats are {export_fmts_hub()}"
    r = requests.post(
        f"{HUB_API_ROOT}/get-export",
        json={"apiKey": Auth().api_key, "modelId": model_id, "format": format},
        headers={"x-api-key": Auth().api_key},
    )
    assert r.status_code == 200, f"{PREFIX}{format} get_export failure {r.status_code} {r.reason}"
    return r.json()



ultralytics.hub.check_dataset(path='', task='detect')

त्रुटि-जाँच के लिए कार्य HUB अपलोड करने से पहले डेटासेट ज़िप फ़ाइल। यह अपलोड होने से पहले त्रुटियों के लिए डेटासेट की जांच करता है को HUB. उपयोग के उदाहरण नीचे दिए गए हैं।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
path str

डेटा का पथ.zip (डेटा.zip अंदर data.yaml के साथ)। '' के लिए डिफ़ॉल्ट।

''
task str

डेटासेट कार्य। विकल्प 'पता लगाएं', 'सेगमेंट', 'पोज़', 'वर्गीकृत' हैं। 'पता लगाने' के लिए डिफ़ॉल्ट।

'detect'
उदाहरण
from ultralytics.hub import check_dataset

check_dataset('path/to/coco8.zip', task='detect')  # detect dataset
check_dataset('path/to/coco8-seg.zip', task='segment')  # segment dataset
check_dataset('path/to/coco8-pose.zip', task='pose')  # pose dataset
में स्रोत कोड ultralytics/hub/__init__.py
109 110 111 112 113 114 115 116 117 118 119 120121 122 123 124 125 126 127 128
def check_dataset(path="", task="detect"):
    """
    Function for error-checking HUB dataset Zip file before upload. It checks a dataset for errors before it is uploaded
    to the HUB. Usage examples are given below.

    Args:
        path (str, optional): Path to data.zip (with data.yaml inside data.zip). Defaults to ''.
        task (str, optional): Dataset task. Options are 'detect', 'segment', 'pose', 'classify'. Defaults to 'detect'.

    Example:
        ```python
        from ultralytics.hub import check_dataset

        check_dataset('path/to/coco8.zip', task='detect')  # detect dataset
        check_dataset('path/to/coco8-seg.zip', task='segment')  # segment dataset
        check_dataset('path/to/coco8-pose.zip', task='pose')  # pose dataset
        ```
    """
    HUBDatasetStats(path=path, task=task).get_json()
    LOGGER.info(f"Checks completed correctly ✅. Upload this dataset to {HUB_WEB_ROOT}/datasets/.")





2023-11-12 बनाया गया, अपडेट किया गया 2023-11-25
लेखक: ग्लेन-जोचर (3)