From dc36154386ce60904d9e9691d478b1f34b7262a8 Mon Sep 17 00:00:00 2001 From: sayakpaul Date: Tue, 14 Oct 2025 14:29:44 +0530 Subject: [PATCH 1/3] feat: allow get_kernel to log telemetry. --- src/kernels/utils.py | 45 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 42 insertions(+), 3 deletions(-) diff --git a/src/kernels/utils.py b/src/kernels/utils.py index a942490..12a7358 100644 --- a/src/kernels/utils.py +++ b/src/kernels/utils.py @@ -11,7 +11,7 @@ from importlib.metadata import Distribution from pathlib import Path from types import ModuleType -from typing import Dict, List, Optional, Tuple +from typing import Dict, List, Optional, Tuple, Union from huggingface_hub import file_exists, snapshot_download from packaging.version import parse @@ -19,6 +19,8 @@ from kernels._versions import select_revision_or_version from kernels.lockfile import KernelLock, VariantLock +ENV_VARS_TRUE_VALUES = {"1", "ON", "YES", "TRUE"} + def _get_cache_dir() -> Optional[str]: """Returns the kernels cache directory.""" @@ -108,6 +110,7 @@ def install_kernel( revision: str, local_files_only: bool = False, variant_locks: Optional[Dict[str, VariantLock]] = None, + user_agent: Optional[Union[str, dict]] = None, ) -> Tuple[str, Path]: """ Download a kernel for the current environment to the cache. @@ -123,6 +126,8 @@ def install_kernel( Whether to only use local files and not download from the Hub. variant_locks (`Dict[str, VariantLock]`, *optional*): Optional dictionary of variant locks for validation. + user_agent (`Union[str, dict]`, *optional*): + The `user_agent` info to pass to `snapshot_download()` for internal telemetry. Returns: `Tuple[str, Path]`: A tuple containing the package name and the path to the variant directory. @@ -130,6 +135,7 @@ def install_kernel( package_name = package_name_from_repo_id(repo_id) variant = build_variant() universal_variant = universal_build_variant() + user_agent = _get_user_agent(user_agent=user_agent) repo_path = Path( snapshot_download( repo_id, @@ -137,6 +143,7 @@ def install_kernel( cache_dir=CACHE_DIR, revision=revision, local_files_only=local_files_only, + user_agent=user_agent, ) ) @@ -213,7 +220,10 @@ def install_kernel_all_variants( def get_kernel( - repo_id: str, revision: Optional[str] = None, version: Optional[str] = None + repo_id: str, + revision: Optional[str] = None, + version: Optional[str] = None, + user_agent: Optional[Union[str, dict]] = None, ) -> ModuleType: """ Load a kernel from the kernel hub. @@ -229,6 +239,8 @@ def get_kernel( version (`str`, *optional*): The kernel version to download. This can be a Python version specifier, such as `">=1.0.0,<2.0.0"`. Cannot be used together with `revision`. + user_agent (`Union[str, dict]`, *optional*): + The `user_agent` info to pass to `snapshot_download()` for internal telemetry. Returns: `ModuleType`: The imported kernel module. @@ -245,7 +257,9 @@ def get_kernel( ``` """ revision = select_revision_or_version(repo_id, revision, version) - package_name, package_path = install_kernel(repo_id, revision=revision) + package_name, package_path = install_kernel( + repo_id, revision=revision, user_agent=user_agent + ) return import_from_path(package_name, package_path / package_name / "__init__.py") @@ -501,3 +515,28 @@ def git_hash_object(data: bytes, object_type: str = "blob"): def package_name_from_repo_id(repo_id: str) -> str: return repo_id.split("/")[-1].replace("-", "_") + + +def _get_user_agent( + user_agent: Optional[Union[dict, str]] = None, +) -> Union[None, dict, str]: + import torch + + from . import __version__ + + disable_telemetry = ( + os.getenv("DISABLE_TELEMETRY", "false").upper() in ENV_VARS_TRUE_VALUES + ) + + if user_agent is None: + user_agent = { + "kernels": __version__, + "torch": torch.__version__, + "build_variant": build_variant(), + "file_type": "kernel", + } + + if disable_telemetry: + user_agent = None + + return user_agent From b175ed9d0a09e134b717f4fbbf3630a1fd14669f Mon Sep 17 00:00:00 2001 From: Sayak Paul Date: Tue, 14 Oct 2025 19:10:41 +0530 Subject: [PATCH 2/3] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Daniël de Kok --- src/kernels/utils.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/src/kernels/utils.py b/src/kernels/utils.py index 12a7358..0b375e2 100644 --- a/src/kernels/utils.py +++ b/src/kernels/utils.py @@ -524,9 +524,8 @@ def _get_user_agent( from . import __version__ - disable_telemetry = ( - os.getenv("DISABLE_TELEMETRY", "false").upper() in ENV_VARS_TRUE_VALUES - ) + if os.getenv("DISABLE_TELEMETRY", "false").upper() in ENV_VARS_TRUE_VALUES: + return None if user_agent is None: user_agent = { @@ -536,7 +535,4 @@ def _get_user_agent( "file_type": "kernel", } - if disable_telemetry: - user_agent = None - return user_agent From bb303522113e0d8d3c9c0a6ffab4cb5a2f61d79e Mon Sep 17 00:00:00 2001 From: sayakpaul Date: Thu, 16 Oct 2025 20:59:05 +0530 Subject: [PATCH 3/3] doc --- docs/source/faq.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/faq.md b/docs/source/faq.md index 2946139..bc7464e 100644 --- a/docs/source/faq.md +++ b/docs/source/faq.md @@ -39,3 +39,13 @@ The approach of `forward`-replacement is the least invasive, because it preserves the original model graph. It is also reversible, since even though the `forward` of a layer _instance_ might be replaced, the corresponding class still has the original `forward`. + +## Misc + +### How can I disable kernel reporting in the user-agent? + +By default, we collect telemetry when a call to `get_kernel()` is made. +This only includes the `kernels` version, `torch` version, and the build +information for the kernel being requested. + +You can disable this by setting `export DISABLE_TELEMETRY=yes`.