truefoundry 0.4.1rc1__tar.gz → 0.4.2rc2__tar.gz

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: truefoundry
-Version: 0.4.1rc1
+Version: 0.4.2rc2
 Summary: Truefoundry CLI
 Author: Abhishek Choudhary
 Author-email: abhishek@truefoundry.com

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "truefoundry"
-version = "0.4.1rc1"
+version = "0.4.2rc2"
 description = "Truefoundry CLI"
 authors = ["Abhishek Choudhary <abhishek@truefoundry.com>"]
 readme = "README.md"

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/common/auth_service_client.py

@@ -8,7 +8,7 @@ from truefoundry.common.constants import VERSION_PREFIX
 from truefoundry.common.entities import DeviceCode, Token
 from truefoundry.common.exceptions import BadRequestException
 from truefoundry.common.request_utils import request_handling, requests_retry_session
-from truefoundry.common.utils import poll_for_function
+from truefoundry.common.utils import poll_for_function, relogin_error_message
 from truefoundry.logger import logger
 
 
@@ -16,6 +16,7 @@ class AuthServiceClient(ABC):
     def __init__(self, tenant_name: str):
         self._tenant_name = tenant_name
 
+    # TODO (chiragjn): Rename base_url to tfy_host
     @classmethod
     def from_base_url(cls, base_url: str) -> "AuthServiceClient":
         from truefoundry.common.servicefoundry_client import (
@@ -54,7 +55,9 @@ class ServiceFoundryServerAuthServiceClient(AuthServiceClient):
         if not token.refresh_token:
             # TODO: Add a way to propagate error messages without traceback to the output interface side
             raise Exception(
-                f"Unable to resume login session. Please log in again using `tfy login {host_arg_str} --relogin`"
+                relogin_error_message(
+                    "Unable to resume login session.", host=host_arg_str
+                )
             )
         url = f"{self._api_server_url}/{VERSION_PREFIX}/oauth2/token"
         data = {
@@ -70,7 +73,9 @@ class ServiceFoundryServerAuthServiceClient(AuthServiceClient):
             return Token.parse_obj(response_data)
         except BadRequestException as ex:
             raise Exception(
-                f"Unable to resume login session. Please log in again using `tfy login {host_arg_str} --relogin`"
+                relogin_error_message(
+                    "Unable to resume login session.", host=host_arg_str
+                )
             ) from ex
 
     def get_device_code(self) -> DeviceCode:
@@ -127,7 +132,9 @@ class AuthServerServiceClient(AuthServiceClient):
         if not token.refresh_token:
             # TODO: Add a way to propagate error messages without traceback to the output interface side
             raise Exception(
-                f"Unable to resume login session. Please log in again using `tfy login {host_arg_str} --relogin`"
+                relogin_error_message(
+                    "Unable to resume login session.", host=host_arg_str
+                )
             )
         url = f"{self._auth_server_url}/api/{VERSION_PREFIX}/oauth/token/refresh"
         data = {
@@ -141,7 +148,9 @@ class AuthServerServiceClient(AuthServiceClient):
             return Token.parse_obj(response_data)
         except BadRequestException as ex:
             raise Exception(
-                f"Unable to resume login session. Please log in again using `tfy login {host_arg_str} --relogin`"
+                relogin_error_message(
+                    "Unable to resume login session.", host=host_arg_str
+                )
             ) from ex
 
     def get_device_code(self) -> DeviceCode:

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/common/credential_file_manager.py

@@ -10,6 +10,7 @@ from filelock import FileLock, Timeout
 
 from truefoundry.common.constants import CREDENTIAL_FILEPATH
 from truefoundry.common.entities import CredentialsFileContent
+from truefoundry.common.utils import relogin_error_message
 from truefoundry.logger import logger
 
 
@@ -87,9 +88,9 @@ class CredentialsFileManager:
             return CredentialsFileContent.parse_file(self._credentials_file_path)
         except Exception as ex:
             raise Exception(
-                "Error while reading the credentials file "
-                f"{self._credentials_file_path}. Please login again "
-                "using `tfy login --relogin` or `tfy.login(relogin=True)` function"
+                relogin_error_message(
+                    f"Error while reading the credentials file {self._credentials_file_path}"
+                )
             ) from ex
 
     @_ensure_lock_taken

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/common/credential_provider.py

@@ -6,7 +6,7 @@ from truefoundry.common.auth_service_client import AuthServiceClient
 from truefoundry.common.constants import TFY_API_KEY_ENV_KEY
 from truefoundry.common.credential_file_manager import CredentialsFileManager
 from truefoundry.common.entities import CredentialsFileContent, Token
-from truefoundry.common.utils import resolve_base_url
+from truefoundry.common.utils import resolve_tfy_host
 from truefoundry.logger import logger
 
 TOKEN_REFRESH_LOCK = threading.RLock()
@@ -17,6 +17,7 @@ class CredentialProvider(ABC):
     @abstractmethod
     def token(self) -> Token: ...
 
+    # TODO (chiragjn): Rename base_url to tfy_host
     @property
     @abstractmethod
     def base_url(self) -> str: ...
@@ -34,10 +35,8 @@ class EnvCredentialProvider(CredentialProvider):
             raise Exception(
                 f"Value of {TFY_API_KEY_ENV_KEY} env var should be non-empty string"
             )
-        # TODO: Read host from cred file as well.
-        base_url = resolve_base_url().strip("/")
-        self._host = base_url
-        self._auth_service = AuthServiceClient.from_base_url(base_url=base_url)
+        self._host = resolve_tfy_host()
+        self._auth_service = AuthServiceClient.from_base_url(base_url=self._host)
         self._token: Token = Token(access_token=api_key, refresh_token=None)  # type: ignore[call-arg]
 
     @staticmethod

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/common/servicefoundry_client.py

@@ -68,6 +68,7 @@ def _cached_get_python_sdk_config(api_server_url: str) -> PythonSDKConfig:
 
 
 class ServiceFoundryServiceClient:
+    # TODO (chiragjn): Rename base_url to tfy_host
     def __init__(self, base_url: str):
         self._base_url = base_url.strip("/")
         self._api_server_url = append_servicefoundry_path_to_base_url(self._base_url)

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/common/utils.py

@@ -14,6 +14,17 @@ from truefoundry.common.constants import (
 T = TypeVar("T")
 
 
+def relogin_error_message(message: str, host: str = "HOST") -> str:
+    suffix = ""
+    if host == "HOST":
+        suffix = " where HOST is TrueFoundry platform URL"
+    return (
+        f"{message}\n"
+        f"Please login again using `tfy login --host {host} --relogin` "
+        f"or `truefoundry.login(host={host!r}, relogin=True)` function" + suffix
+    )
+
+
 def timed_lru_cache(
     seconds: int = 300, maxsize: Optional[int] = None
 ) -> Callable[[Callable[..., T]], Callable[..., T]]:
@@ -42,14 +53,25 @@ def poll_for_function(
         time.sleep(poll_after_secs)
 
 
-def resolve_base_url(host: Optional[str] = None) -> str:
-    if not host and not os.getenv(TFY_HOST_ENV_KEY):
+def validate_tfy_host(tfy_host: str) -> str:
+    if not (tfy_host.startswith("https://") or tfy_host.startswith("http://")):
+        raise ValueError(
+            f"Invalid host {tfy_host!r}. It should start with https:// or http://"
+        )
+
+
+def resolve_tfy_host(tfy_host: Optional[str] = None) -> str:
+    if not tfy_host and not os.getenv(TFY_HOST_ENV_KEY):
         raise ValueError(
-            f"Either `host` should be provided by --host <value>, or `{TFY_HOST_ENV_KEY}` env must be set"
+            f"Either `host` should be provided using `--host <value>`, or `{TFY_HOST_ENV_KEY}` env must be set"
         )
-    return host or os.getenv(TFY_HOST_ENV_KEY)
+    tfy_host = tfy_host or os.getenv(TFY_HOST_ENV_KEY)
+    tfy_host = tfy_host.strip("/")
+    validate_tfy_host(tfy_host)
+    return tfy_host
 
 
+# TODO (chiragjn): Rename base_url to tfy_host
 def append_servicefoundry_path_to_base_url(base_url: str):
     if urlsplit(base_url).netloc.startswith("localhost"):
         return os.getenv(SERVICEFOUNDRY_SERVER_URL_ENV_KEY)

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/deploy/auto_gen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2024-09-29T10:28:22+00:00
+#   timestamp: 2024-10-09T13:00:44+00:00
 
 from __future__ import annotations
 
@@ -363,10 +363,12 @@ class HelmRepo(BaseModel):
         description="+label=Helm repository URL\n+sort=1\n+message=Needs to be a valid URL.",
     )
     chart: str = Field(
-        ..., description="+label=Chart name\n+sort=2\n+usage=The helm chart name"
+        ...,
+        description='+label=Chart name\n+sort=2\n+usage=The helm chart name\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
     )
     version: str = Field(
-        ..., description="+label=Version\n+sort=3\n+usage=Helm chart version"
+        ...,
+        description='+label=Version\n+sort=3\n+usage=Helm chart version\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
     )
 
 
@@ -448,10 +450,14 @@ class JobAlert(BaseModel):
     +label=Alert
     """
 
-    notification_channel: str = Field(
+    notification_channel: constr(min_length=1) = Field(
         ...,
         description='+label=Notification Channel\n+usage=Specify the notification channel to send alerts to\n+uiType=IntegrationSelect\n+uiProps={"integrationType":"notification-channel"}\n+sort=660',
     )
+    to_emails: Optional[List[constr(min_length=1)]] = Field(
+        None,
+        description="+label=To Emails\n+usage=List of recipients' email addresses if the notification channel is Email.\n+docs=Specify the emails to send alerts to\n+sort=665",
+    )
     on_start: bool = Field(
         False,
         description="+label=On Start\n+usage=Send an alert when the job starts\n+sort=670",
@@ -1546,7 +1552,7 @@ class SSHServer(BaseWorkbenchInput):
     image: WorkbenchImage
     ssh_public_key: str = Field(
         ...,
-        description="+label: SSH Public Key\n+usage=Add Your SSH Public Key, this will be used to authenticate you to the SSH Server. You can find it using `cat ~/.ssh/id_rsa.pub`\n+sort=4",
+        description="+label: SSH Public Key\n+usage=Add Your SSH Public Key, this will be used to authenticate you to the SSH Server.  \\\nYou can find it using `cat ~/.ssh/id_rsa.pub` in Mac/Linux or `type $home\\.ssh\\id_rsa.pub` in Windows Powershell.  \\\nYou can also generate a new SSH key pair using `ssh-keygen -t rsa` in your local terminal. (same for both Mac/Linux and Windows Powershell)\n+uiType=TextArea\n+sort=4",
     )
 
 

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/deploy/lib/auth/servicefoundry_session.py

@@ -8,6 +8,7 @@ from truefoundry.common.credential_provider import (
     FileCredentialProvider,
 )
 from truefoundry.common.entities import UserInfo
+from truefoundry.common.utils import relogin_error_message
 from truefoundry.logger import logger
 
 ACTIVE_SESSION: Optional[ServiceFoundrySession] = None
@@ -41,8 +42,9 @@ class ServiceFoundrySession:
                 break
         if final_cred_provider is None:
             raise Exception(
-                "Please login again using `tfy login --relogin`"
-                "or `tfy.login(relogin=True)` function"
+                relogin_error_message(
+                    "No active session found. Perhaps you are not logged in?",
+                )
             )
         return final_cred_provider
 

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/deploy/lib/clients/servicefoundry_client.py

@@ -76,6 +76,7 @@ def _upload_packaged_code(metadata, package_file):
 
 
 class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
+    # TODO (chiragjn): Rename base_url to tfy_host
     def __init__(self, init_session: bool = True, base_url: Optional[str] = None):
         self._session: Optional[ServiceFoundrySession] = None
         if init_session:

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/deploy/lib/session.py

@@ -8,7 +8,7 @@ from truefoundry.common.constants import TFY_API_KEY_ENV_KEY, TFY_HOST_ENV_KEY
 from truefoundry.common.credential_file_manager import CredentialsFileManager
 from truefoundry.common.credential_provider import EnvCredentialProvider
 from truefoundry.common.entities import CredentialsFileContent, Token
-from truefoundry.common.utils import resolve_base_url
+from truefoundry.common.utils import relogin_error_message, resolve_tfy_host
 from truefoundry.deploy.io.output_callback import OutputCallBack
 from truefoundry.deploy.lib.const import (
     RICH_OUTPUT_CALLBACK,
@@ -43,7 +43,7 @@ def login(
             "Login will just save the credentials on disk."
         )
 
-    host = resolve_base_url(host).strip("/")
+    host = resolve_tfy_host(host)
 
     with CredentialsFileManager() as cred_file:
         if not relogin and cred_file.exists():
@@ -58,10 +58,10 @@ def login(
             user_info = cred_file_content.to_token().to_user_info()
             user_name_display_info = user_info.email or user_info.user_type.value
             output_hook.print_line(
-                f"Already logged in to {cred_file_content.host!r} as "
-                f"{user_info.user_id!r} ({user_name_display_info})\n"
-                "Please use `tfy login --relogin` or `tfy.login(relogin=True)` "
-                "to force relogin"
+                relogin_error_message(
+                    f"Already logged in to {cred_file_content.host!r} as {user_info.user_id!r} ({user_name_display_info})",
+                    host=host,
+                )
             )
             return False
 

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/ml/clients/servicefoundry_client.py

@@ -16,6 +16,7 @@ from truefoundry.ml.run_utils import append_servicefoundry_path_to_tracking_uri
 
 
 class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
+    # TODO (chiragjn): Rename tracking_uri to tfy_host
     def __init__(self, tracking_uri: str, token: Optional[str] = None):
         super().__init__(base_url=tracking_uri)
         self.host_creds = HostCreds(

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/ml/mlfoundry_api.py

@@ -7,6 +7,7 @@ from typing import Any, Dict, Iterator, List, Optional, Sequence, Tuple, Union
 import coolname
 import pandas as pd
 
+from truefoundry.common.utils import relogin_error_message
 from truefoundry.ml import constants, env_vars
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactDto,
@@ -213,8 +214,9 @@ class MlFoundry:
         session = get_active_session()
         if session is None:
             raise MlFoundryException(
-                "No active session found. Perhaps you are not logged in?\n"
-                "Please log in using `tfy login [--host HOST] --relogin"
+                relogin_error_message(
+                    "No active session found. Perhaps you are not logged in?",
+                )
             )
         servicefoundry_client = ServiceFoundryServiceClient(
             tracking_uri=self.get_tracking_uri(),

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/ml/mlfoundry_run.py

@@ -19,6 +19,7 @@ from typing import (
 from urllib.parse import urljoin, urlsplit
 
 from truefoundry import version
+from truefoundry.common.utils import relogin_error_message
 from truefoundry.ml import constants, enums
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactType,
@@ -51,6 +52,8 @@ from truefoundry.ml.run_utils import ParamsType, flatten_dict, process_params
 from truefoundry.ml.session import ACTIVE_RUNS, _get_api_client, get_active_session
 from truefoundry.ml.validation_utils import (
     MAX_ENTITY_KEY_LENGTH,
+    MAX_METRICS_PER_BATCH,
+    MAX_PARAMS_TAGS_PER_BATCH,
     _validate_batch_log_data,
 )
 
@@ -222,8 +225,9 @@ class MlFoundryRun:
         session = get_active_session()
         if session is None:
             raise MlFoundryException(
-                "No active session found. Perhaps you are not logged in?\n"
-                "Please log in using `tfy login [--host HOST] --relogin"
+                relogin_error_message(
+                    "No active session found. Perhaps you are not logged in?",
+                )
             )
         base_url = "{uri.scheme}://{uri.netloc}/".format(
             uri=urlsplit(session.tracking_uri)
@@ -636,12 +640,16 @@ class MlFoundryRun:
             return
 
         try:
-            _validate_batch_log_data(metrics=metrics, params=[], tags=[])
-            self._runs_api.log_run_batch_post(
-                log_batch_request_dto=LogBatchRequestDto(
-                    run_id=self.run_id, metrics=metrics, params=[], tags=[]
+            for i in range(0, len(metrics), MAX_METRICS_PER_BATCH):
+                metrics_batch = metrics[i : i + MAX_METRICS_PER_BATCH]
+
+                _validate_batch_log_data(metrics=metrics_batch, params=[], tags=[])
+
+                self._runs_api.log_run_batch_post(
+                    log_batch_request_dto=LogBatchRequestDto(
+                        run_id=self.run_id, metrics=metrics_batch, params=[], tags=[]
+                    )
                 )
-            )
         except Exception as e:
             raise MlFoundryException(str(e)) from e
 
@@ -723,12 +731,17 @@ class MlFoundryRun:
             if len(params) == 0:
                 logger.warning("Cannot log empty params dictionary")
 
-            _validate_batch_log_data(metrics=[], params=params, tags=[])
-            self._runs_api.log_run_batch_post(
-                log_batch_request_dto=LogBatchRequestDto(
-                    run_id=self.run_id, metrics=[], params=params, tags=[]
+            for i in range(0, len(params), MAX_PARAMS_TAGS_PER_BATCH):
+                params_batch = params[i : i + MAX_PARAMS_TAGS_PER_BATCH]
+
+                _validate_batch_log_data(metrics=[], params=params_batch, tags=[])
+                logger.debug("Logging parameters: %s", params_batch)
+
+                self._runs_api.log_run_batch_post(
+                    log_batch_request_dto=LogBatchRequestDto(
+                        run_id=self.run_id, metrics=[], params=params_batch, tags=[]
+                    )
                 )
-            )
         except Exception as e:
             raise MlFoundryException(str(e)) from e
         logger.info("Parameters logged successfully")
@@ -765,11 +778,15 @@ class MlFoundryRun:
             tags_arr = [
                 RunTagDto(key=key, value=str(value)) for key, value in tags.items()
             ]
-            self._runs_api.log_run_batch_post(
-                log_batch_request_dto=LogBatchRequestDto(
-                    run_id=self.run_id, metrics=[], params=[], tags=tags_arr
+            for i in range(0, len(tags_arr), MAX_PARAMS_TAGS_PER_BATCH):
+                tags_batch = tags_arr[i : i + MAX_PARAMS_TAGS_PER_BATCH]
+
+                _validate_batch_log_data(metrics=[], params=[], tags=tags_batch)
+                self._runs_api.log_run_batch_post(
+                    log_batch_request_dto=LogBatchRequestDto(
+                        run_id=self.run_id, metrics=[], params=[], tags=tags_batch
+                    )
                 )
-            )
         except Exception as e:
             raise MlFoundryException(str(e)) from e
         logger.info("Tags set successfully")

{truefoundry-0.4.1rc1 → truefoundry-0.4.2rc2}/truefoundry/ml/session.py

@@ -10,6 +10,7 @@ from truefoundry.common.credential_provider import (
 )
 from truefoundry.common.entities import Token, UserInfo
 from truefoundry.common.request_utils import urllib3_retry
+from truefoundry.common.utils import relogin_error_message
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ApiClient,
     Configuration,
@@ -83,6 +84,7 @@ class Session:
         self._assert_not_closed()
         return self._user_info
 
+    # TODO (chiragjn): Rename tracking_uri to tfy_host
     @property
     def tracking_uri(self) -> str:
         return self._cred_provider.base_url
@@ -120,8 +122,9 @@ def _get_api_client(
             return ApiClient()
         else:
             raise MlFoundryException(
-                "No active session found. Perhaps you are not logged in?\n"
-                "Please log in using `tfy login [--host HOST] --relogin"
+                relogin_error_message(
+                    "No active session found. Perhaps you are not logged in?",
+                )
             )
 
     creds = session.get_host_creds()
@@ -144,8 +147,9 @@ def init_session() -> Session:
                 break
         if final_cred_provider is None:
             raise MlFoundryException(
-                "Please login using `tfy login` command "
-                "or `truefoundry.login()` function call"
+                relogin_error_message(
+                    "No active session found. Perhaps you are not logged in?",
+                )
             )
         new_session = Session(cred_provider=final_cred_provider)