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

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

नोट

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



ultralytics.hub.utils.Events

अनाम घटना विश्लेषण एकत्र करने के लिए एक वर्ग। इवेंट विश्लेषण तब सक्षम होते हैं जब sync=True सेटिंग्स में और अक्षम जब sync=False. भागो 'yolo सेटिंग्स 'देखने और अपडेट करने के लिए सेटिंग्स YAML फ़ाइल।

विशेषताएँ:

नाम प्रकार या क़िस्‍म
url str

अनाम ईवेंट भेजने का URL.

rate_limit float

ईवेंट भेजने के लिए सेकंड में दर सीमा।

metadata dict

पर्यावरण के बारे में मेटाडेटा रखने वाला एक शब्दकोश।

enabled bool

कुछ शर्तों के आधार पर ईवेंट्स को सक्षम या अक्षम करने के लिए एक ध्वज।

में स्रोत कोड ultralytics/hub/utils.py
class Events:
    """
    A class for collecting anonymous event analytics. Event analytics are enabled when sync=True in settings and
    disabled when sync=False. Run 'yolo settings' to see and update settings YAML file.

    Attributes:
        url (str): The URL to send anonymous events.
        rate_limit (float): The rate limit in seconds for sending events.
        metadata (dict): A dictionary containing metadata about the environment.
        enabled (bool): A flag to enable or disable Events based on certain conditions.
    """

    url = "https://www.google-analytics.com/mp/collect?measurement_id=G-X8NCJYTQXM&api_secret=QLQrATrNSwGRFRLE-cbHJw"

    def __init__(self):
        """Initializes the Events object with default values for events, rate_limit, and metadata."""
        self.events = []  # events list
        self.rate_limit = 60.0  # rate limit (seconds)
        self.t = 0.0  # rate limit timer (seconds)
        self.metadata = {
            "cli": Path(ARGV[0]).name == "yolo",
            "install": "git" if IS_GIT_DIR else "pip" if IS_PIP_PACKAGE else "other",
            "python": ".".join(platform.python_version_tuple()[:2]),  # i.e. 3.10
            "version": __version__,
            "env": ENVIRONMENT,
            "session_id": round(random.random() * 1e15),
            "engagement_time_msec": 1000,
        }
        self.enabled = (
            SETTINGS["sync"]
            and RANK in {-1, 0}
            and not TESTS_RUNNING
            and ONLINE
            and (IS_PIP_PACKAGE or get_git_origin_url() == "https://github.com/ultralytics/ultralytics.git")
        )

    def __call__(self, cfg):
        """
        Attempts to add a new event to the events list and send events if the rate limit is reached.

        Args:
            cfg (IterableSimpleNamespace): The configuration object containing mode and task information.
        """
        if not self.enabled:
            # Events disabled, do nothing
            return

        # Attempt to add to events
        if len(self.events) < 25:  # Events list limited to 25 events (drop any events past this)
            params = {
                **self.metadata,
                "task": cfg.task,
                "model": cfg.model if cfg.model in GITHUB_ASSETS_NAMES else "custom",
            }
            if cfg.mode == "export":
                params["format"] = cfg.format
            self.events.append({"name": cfg.mode, "params": params})

        # Check rate limit
        t = time.time()
        if (t - self.t) < self.rate_limit:
            # Time is under rate limiter, wait to send
            return

        # Time is over rate limiter, send now
        data = {"client_id": SETTINGS["uuid"], "events": self.events}  # SHA-256 anonymized UUID hash and events list

        # POST equivalent to requests.post(self.url, json=data)
        smart_request("post", self.url, json=data, retry=0, verbose=False)

        # Reset events and rate limit timer
        self.events = []
        self.t = t

__call__(cfg)

ईवेंट सूची में एक नया ईवेंट जोड़ने का प्रयास करता है और यदि दर सीमा पूरी हो जाती है तो ईवेंट भेजता है.

पैरामीटर:

नाम प्रकार या क़िस्‍म चूक
cfg IterableSimpleNamespace

कॉन्फ़िगरेशन ऑब्जेक्ट जिसमें मोड और कार्य जानकारी होती है.

आवश्यक
में स्रोत कोड ultralytics/hub/utils.py
def __call__(self, cfg):
    """
    Attempts to add a new event to the events list and send events if the rate limit is reached.

    Args:
        cfg (IterableSimpleNamespace): The configuration object containing mode and task information.
    """
    if not self.enabled:
        # Events disabled, do nothing
        return

    # Attempt to add to events
    if len(self.events) < 25:  # Events list limited to 25 events (drop any events past this)
        params = {
            **self.metadata,
            "task": cfg.task,
            "model": cfg.model if cfg.model in GITHUB_ASSETS_NAMES else "custom",
        }
        if cfg.mode == "export":
            params["format"] = cfg.format
        self.events.append({"name": cfg.mode, "params": params})

    # Check rate limit
    t = time.time()
    if (t - self.t) < self.rate_limit:
        # Time is under rate limiter, wait to send
        return

    # Time is over rate limiter, send now
    data = {"client_id": SETTINGS["uuid"], "events": self.events}  # SHA-256 anonymized UUID hash and events list

    # POST equivalent to requests.post(self.url, json=data)
    smart_request("post", self.url, json=data, retry=0, verbose=False)

    # Reset events and rate limit timer
    self.events = []
    self.t = t

__init__()

ईवेंट, rate_limit और मेटाडेटा के लिए डिफ़ॉल्ट मानों के साथ ईवेंट ऑब्जेक्ट को इनिशियलाइज़ करता है।

में स्रोत कोड ultralytics/hub/utils.py
def __init__(self):
    """Initializes the Events object with default values for events, rate_limit, and metadata."""
    self.events = []  # events list
    self.rate_limit = 60.0  # rate limit (seconds)
    self.t = 0.0  # rate limit timer (seconds)
    self.metadata = {
        "cli": Path(ARGV[0]).name == "yolo",
        "install": "git" if IS_GIT_DIR else "pip" if IS_PIP_PACKAGE else "other",
        "python": ".".join(platform.python_version_tuple()[:2]),  # i.e. 3.10
        "version": __version__,
        "env": ENVIRONMENT,
        "session_id": round(random.random() * 1e15),
        "engagement_time_msec": 1000,
    }
    self.enabled = (
        SETTINGS["sync"]
        and RANK in {-1, 0}
        and not TESTS_RUNNING
        and ONLINE
        and (IS_PIP_PACKAGE or get_git_origin_url() == "https://github.com/ultralytics/ultralytics.git")
    )



ultralytics.hub.utils.request_with_credentials(url)

Google Colab परिवेश में संलग्न कुकी के साथ AJAX अनुरोध करें.

पैरामीटर:

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

अनुरोध करने के लिए URL।

आवश्यक

देता:

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

AJAX अनुरोध से प्रतिक्रिया डेटा।

उठाती:

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

यदि फ़ंक्शन Google Colab वातावरण में नहीं चलाया जाता है।

में स्रोत कोड ultralytics/hub/utils.py
def request_with_credentials(url: str) -> any:
    """
    Make an AJAX request with cookies attached in a Google Colab environment.

    Args:
        url (str): The URL to make the request to.

    Returns:
        (any): The response data from the AJAX request.

    Raises:
        OSError: If the function is not run in a Google Colab environment.
    """
    if not IS_COLAB:
        raise OSError("request_with_credentials() must run in a Colab environment")
    from google.colab import output  # noqa
    from IPython import display  # noqa

    display.display(
        display.Javascript(
            """
            window._hub_tmp = new Promise((resolve, reject) => {
                const timeout = setTimeout(() => reject("Failed authenticating existing browser session"), 5000)
                fetch("%s", {
                    method: 'POST',
                    credentials: 'include'
                })
                    .then((response) => resolve(response.json()))
                    .then((json) => {
                    clearTimeout(timeout);
                    }).catch((err) => {
                    clearTimeout(timeout);
                    reject(err);
                });
            });
            """
            % url
        )
    )
    return output.eval_js("_hub_tmp")



ultralytics.hub.utils.requests_with_progress(method, url, **kwargs)

वैकल्पिक प्रगति पट्टी के साथ निर्दिष्ट विधि और URL का उपयोग करके HTTP अनुरोध करें।

पैरामीटर:

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

HTTP विधि का उपयोग करें (उदाहरण के लिए "GET", "POST")।

आवश्यक
url str

अनुरोध भेजने के लिए URL.

आवश्यक
**kwargs any

अंतर्निहित को पास करने के लिए अतिरिक्त कीवर्ड तर्क requests.request फलन।

{}

देता:

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

HTTP अनुरोध से प्रतिसाद ऑब्जेक्ट।

नोट
  • यदि 'प्रगति' को सही पर सेट किया गया है, तो प्रगति बार ज्ञात प्रतिक्रियाओं के लिए डाउनलोड प्रगति प्रदर्शित करेगा सामग्री की लंबाई।
  • यदि 'प्रगति' एक संख्या है तो प्रगति पट्टी सामग्री की लंबाई = प्रगति मानते हुए प्रदर्शित होगी।
में स्रोत कोड ultralytics/hub/utils.py
def requests_with_progress(method, url, **kwargs):
    """
    Make an HTTP request using the specified method and URL, with an optional progress bar.

    Args:
        method (str): The HTTP method to use (e.g. 'GET', 'POST').
        url (str): The URL to send the request to.
        **kwargs (any): Additional keyword arguments to pass to the underlying `requests.request` function.

    Returns:
        (requests.Response): The response object from the HTTP request.

    Note:
        - If 'progress' is set to True, the progress bar will display the download progress for responses with a known
        content length.
        - If 'progress' is a number then progress bar will display assuming content length = progress.
    """
    progress = kwargs.pop("progress", False)
    if not progress:
        return requests.request(method, url, **kwargs)
    response = requests.request(method, url, stream=True, **kwargs)
    total = int(response.headers.get("content-length", 0) if isinstance(progress, bool) else progress)  # total size
    try:
        pbar = TQDM(total=total, unit="B", unit_scale=True, unit_divisor=1024)
        for data in response.iter_content(chunk_size=1024):
            pbar.update(len(data))
        pbar.close()
    except requests.exceptions.ChunkedEncodingError:  # avoid 'Connection broken: IncompleteRead' warnings
        response.close()
    return response



ultralytics.hub.utils.smart_request(method, url, retry=3, timeout=30, thread=True, code=-1, verbose=True, progress=False, **kwargs)

'अनुरोध' लाइब्रेरी का उपयोग करके एक HTTP अनुरोध करता है, घातीय बैकऑफ़ के साथ एक निर्दिष्ट टाइमआउट तक पुनः प्रयास करता है।

पैरामीटर:

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

अनुरोध के लिए उपयोग करने के लिए HTTP विधि। विकल्प 'पोस्ट' और 'गेट' हैं।

आवश्यक
url str

अनुरोध करने के लिए URL।

आवश्यक
retry int

हार मानने से पहले प्रयास करने के लिए पुनः प्रयास करने की संख्या। डिफ़ॉल्ट 3 है।

3
timeout int

सेकंड में टाइमआउट जिसके बाद फ़ंक्शन पुनः प्रयास करना छोड़ देगा। डिफ़ॉल्ट 30 है।

30
thread bool

अनुरोध को एक अलग डेमॉन थ्रेड में निष्पादित करना है या नहीं। डिफ़ॉल्ट True है.

True
code int

अनुरोध के लिए एक पहचानकर्ता, जिसका उपयोग लॉगिंग उद्देश्यों के लिए किया जाता है। डिफ़ॉल्ट -1 है।

-1
verbose bool

यह निर्धारित करने के लिए एक ध्वज कि कंसोल पर प्रिंट आउट करना है या नहीं। डिफ़ॉल्ट True है.

True
progress bool

अनुरोध के दौरान प्रगति पट्टी दिखाना है या नहीं। डिफ़ॉल्ट ग़लत है.

False
**kwargs any

विधि में निर्दिष्ट अनुरोध फ़ंक्शन को पारित किए जाने वाले कीवर्ड तर्क।

{}

देता:

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

HTTP प्रतिसाद ऑब्जेक्ट। यदि अनुरोध को एक अलग थ्रेड में निष्पादित किया जाता है, तो कोई नहीं लौटाता है।

में स्रोत कोड ultralytics/hub/utils.py
def smart_request(method, url, retry=3, timeout=30, thread=True, code=-1, verbose=True, progress=False, **kwargs):
    """
    Makes an HTTP request using the 'requests' library, with exponential backoff retries up to a specified timeout.

    Args:
        method (str): The HTTP method to use for the request. Choices are 'post' and 'get'.
        url (str): The URL to make the request to.
        retry (int, optional): Number of retries to attempt before giving up. Default is 3.
        timeout (int, optional): Timeout in seconds after which the function will give up retrying. Default is 30.
        thread (bool, optional): Whether to execute the request in a separate daemon thread. Default is True.
        code (int, optional): An identifier for the request, used for logging purposes. Default is -1.
        verbose (bool, optional): A flag to determine whether to print out to console or not. Default is True.
        progress (bool, optional): Whether to show a progress bar during the request. Default is False.
        **kwargs (any): Keyword arguments to be passed to the requests function specified in method.

    Returns:
        (requests.Response): The HTTP response object. If the request is executed in a separate thread, returns None.
    """
    retry_codes = (408, 500)  # retry only these codes

    @TryExcept(verbose=verbose)
    def func(func_method, func_url, **func_kwargs):
        """Make HTTP requests with retries and timeouts, with optional progress tracking."""
        r = None  # response
        t0 = time.time()  # initial time for timer
        for i in range(retry + 1):
            if (time.time() - t0) > timeout:
                break
            r = requests_with_progress(func_method, func_url, **func_kwargs)  # i.e. get(url, data, json, files)
            if r.status_code < 300:  # return codes in the 2xx range are generally considered "good" or "successful"
                break
            try:
                m = r.json().get("message", "No JSON message.")
            except AttributeError:
                m = "Unable to read JSON."
            if i == 0:
                if r.status_code in retry_codes:
                    m += f" Retrying {retry}x for {timeout}s." if retry else ""
                elif r.status_code == 429:  # rate limit
                    h = r.headers  # response headers
                    m = (
                        f"Rate limit reached ({h['X-RateLimit-Remaining']}/{h['X-RateLimit-Limit']}). "
                        f"Please retry after {h['Retry-After']}s."
                    )
                if verbose:
                    LOGGER.warning(f"{PREFIX}{m} {HELP_MSG} ({r.status_code} #{code})")
                if r.status_code not in retry_codes:
                    return r
            time.sleep(2**i)  # exponential standoff
        return r

    args = method, url
    kwargs["progress"] = progress
    if thread:
        threading.Thread(target=func, args=args, kwargs=kwargs, daemon=True).start()
    else:
        return func(*args, **kwargs)





Created 2023-11-12, Updated 2024-06-02
Authors: glenn-jocher (5), Burhan-Q (1)