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

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

नोट

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



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

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

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

पैरामीटर:

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

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

None
save bool

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

True

देता:

प्रकार या क़िस्‍म
bool

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

में स्रोत कोड ultralytics/hub/__init__.py
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.6")
    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}Get API key from {api_key_url} and then run 'yolo hub login API_KEY'")
        return False



ultralytics.hub.logout()

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

उदाहरण
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()

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

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

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

पैरामीटर:

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

data.zip का पथ (data.zip के अंदर data.yaml के साथ)।

आवश्यक
task str

डेटासेट कार्य। विकल्प 'पता लगाने', 'खंड', 'मुद्रा', 'वर्गीकृत', 'obb' हैं।

आवश्यक
उदाहरण

https://github.com/ से * .zip फ़ाइलें डाउनलोड करेंultralytics/हब/ट्री/मुख्य/example_datasets यानी https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip coco8.zip के लिए।

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
check_dataset('path/to/dota8.zip', task='obb')  # OBB dataset
check_dataset('path/to/imagenet10.zip', task='classify')  # classification dataset

में स्रोत कोड ultralytics/hub/__init__.py
def check_dataset(path: str, task: str) -> None:
    """
    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): Path to data.zip (with data.yaml inside data.zip).
        task (str): Dataset task. Options are 'detect', 'segment', 'pose', 'classify', 'obb'.

    Example:
        Download *.zip files from https://github.com/ultralytics/hub/tree/main/example_datasets
            i.e. https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip for coco8.zip.
        ```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
        check_dataset('path/to/dota8.zip', task='obb')  # OBB dataset
        check_dataset('path/to/imagenet10.zip', task='classify')  # classification 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, अपडेट किया गया 2024-05-18
लेखक: ग्लेन-जोचर (4), बुरहान-क्यू (1)