clarifai 11.1.4rc1__py3-none-any.whl → 11.1.4rc2__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.1.4rc1"
+__version__ = "11.1.4rc2"

clarifai/cli/model.py

@@ -14,16 +14,26 @@ def model():
     type=click.Path(exists=True),
     required=True,
     help='Path to the model directory.')
+@click.option(
+    '--download_checkpoints',
+    is_flag=True,
+    help=
+    'Flag to download checkpoints before uploading and including them in the tar file that is uploaded. Defaults to False, which will use the "when" field in config.yaml checkpoints section which can be "upload", "build", or "runtime".',
+)
 @click.option(
     '--skip_dockerfile',
     is_flag=True,
     help=
     'Flag to skip generating a dockerfile so that you can manually edit an already created dockerfile.',
 )
-def upload(model_path, skip_dockerfile):
+def upload(model_path, download_checkpoints, skip_dockerfile):
   """Upload a model to Clarifai."""
   from clarifai.runners.models.model_builder import upload_model
-  upload_model(model_path, "upload", skip_dockerfile)
+  if download_checkpoints:
+    stage = "any"  # ignore config.yaml and force download now.
+  else:
+    stage = "upload"
+  upload_model(model_path, stage, skip_dockerfile)
 
 
 @model.command()
@@ -38,7 +48,7 @@ def upload(model_path, skip_dockerfile):
     required=False,
     default=None,
     help=
-    'Option path to write the checkpoints to. This will place them in {out_path}/ If not provided it will default to {model_path}/1/checkpoints where the config.yaml is read..'
+    'Option path to write the checkpoints to. This will place them in {out_path}/1/checkpoints If not provided it will default to {model_path}/1/checkpoints where the config.yaml is read.'
 )
 @click.option(
     '--stage',

clarifai/runners/dockerfile_template/Dockerfile.template

@@ -49,7 +49,7 @@ COPY --chown=nonroot:nonroot downloader/unused.yaml /home/nonroot/main/1/checkpo
 #####
 # Download checkpoints if config.yaml has checkpoints.when = "build"
 COPY --link=true config.yaml /home/nonroot/main/
-RUN ["python", "-m", "clarifai.cli", "model", "download-checkpoints", "--model_path", "/home/nonroot/main", "--out_path", "/home/nonroot/main", "--stage", "build"]
+RUN ["python", "-m", "clarifai.cli", "model", "download-checkpoints", "--model_path", "/home/nonroot/main", "--out_path", "/home/nonroot/main/1/checkpoints", "--stage", "build"]
 #####
 
 

clarifai/runners/models/model_builder.py

@@ -18,7 +18,8 @@ from clarifai.client import BaseClient
 from clarifai.runners.models.model_class import ModelClass
 from clarifai.runners.utils.const import (
     AVAILABLE_PYTHON_IMAGES, AVAILABLE_TORCH_IMAGES, CONCEPTS_REQUIRED_MODEL_TYPE,
-    DEFAULT_DOWNLOAD_CHECKPOINT_WHEN, DEFAULT_PYTHON_VERSION, PYTHON_BASE_IMAGE, TORCH_BASE_IMAGE)
+    DEFAULT_DOWNLOAD_CHECKPOINT_WHEN, DEFAULT_PYTHON_VERSION, DEFAULT_RUNTIME_DOWNLOAD_PATH,
+    PYTHON_BASE_IMAGE, TORCH_BASE_IMAGE)
 from clarifai.runners.utils.loader import HuggingFaceLoader
 from clarifai.urls.helper import ClarifaiUrlHelper
 from clarifai.utils.logging import logger
@@ -448,6 +449,9 @@ class ModelBuilder:
   def tar_file(self):
     return f"{self.folder}.tar.gz"
 
+  def default_runtime_checkpoint_path(self):
+    return DEFAULT_RUNTIME_DOWNLOAD_PATH
+
   def download_checkpoints(self, stage: str, checkpoint_path_override: str = None):
     """
     Downloads the checkpoints specified in the config file.
@@ -455,13 +459,16 @@ class ModelBuilder:
     :param stage: The stage of the build process. This is used to determine when to download the
     checkpoints. The stage can be one of ['build', 'upload', 'runtime', 'any']. If "any" it will always try to download
     regardless of what is specified in config.yaml. Otherwise it must match what is in config.yaml
-    :param checkpoint_path_override: The path to download the checkpoints to. If not provided, the
-    default path is used based on the folder ModelUploader was initialized with. The
-    checkpoint_suffix will be appended to the path.
+    :param checkpoint_path_override: The path to download the checkpoints to (with 1/checkpoints added as suffix). If not provided, the
+    default path is used based on the folder ModelUploader was initialized with. The checkpoint_suffix will be appended to the path.
+    If stage is 'runtime' and checkpoint_path_override is None, the default runtime path will be used.
+
+    :return: The path to the downloaded checkpoints. Even if it doesn't download anything, it will return the default path.
     """
+    path = self.checkpoint_path  # default checkpoint path.
     if not self.config.get("checkpoints"):
       logger.info("No checkpoints specified in the config file")
-      return True
+      return path
 
     loader_type, repo_id, hf_token, when = self._validate_config_checkpoints()
     if stage not in ["build", "upload", "runtime", "any"]:
@@ -470,13 +477,15 @@ class ModelBuilder:
       logger.info(
           f"Skipping downloading checkpoints for stage {stage} since config.yaml says to download them at stage {when}"
       )
-      return True  # success seems fine here.
+      return path
 
     success = True
     if loader_type == "huggingface":
       loader = HuggingFaceLoader(repo_id=repo_id, token=hf_token)
-      path = self._checkpoint_path(
-          checkpoint_path_override) if checkpoint_path_override else self.checkpoint_path
+      # for runtime default to /tmp path
+      if stage == "runtime" and checkpoint_path_override is None:
+        checkpoint_path_override = self.default_runtime_checkpoint_path()
+      path = checkpoint_path_override if checkpoint_path_override else self.checkpoint_path
       success = loader.download_checkpoints(path)
 
     if loader_type:
@@ -485,7 +494,7 @@ class ModelBuilder:
         sys.exit(1)
       else:
         logger.info(f"Downloaded checkpoints for model {repo_id}")
-    return success
+    return path
 
   def _concepts_protos_from_concepts(self, concepts):
     concept_protos = []

clarifai/runners/utils/const.py

@@ -15,6 +15,9 @@ DEFAULT_PYTHON_VERSION = 3.12
 # By default we download at runtime.
 DEFAULT_DOWNLOAD_CHECKPOINT_WHEN = "runtime"
 
+# Folder for downloading checkpoints at runtime.
+DEFAULT_RUNTIME_DOWNLOAD_PATH = "/tmp/.cache"
+
 # List of available torch images
 # Keep sorted by most recent cuda version.
 AVAILABLE_TORCH_IMAGES = [

{clarifai-11.1.4rc1.dist-info → clarifai-11.1.4rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clarifai
-Version: 11.1.4rc1
+Version: 11.1.4rc2
 Summary: Clarifai Python SDK
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai

{clarifai-11.1.4rc1.dist-info → clarifai-11.1.4rc2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-clarifai/__init__.py,sha256=eESbUAmBr4Jl-jJylhTb4-GAaNJQmRNVsHCuh91pv3A,26
+clarifai/__init__.py,sha256=5OapSO2V91rqpOHdVy0RsIMd_yhKwAFpy7L2nTUB7hM,26
 clarifai/cli.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/errors.py,sha256=RwzTajwds51wLD0MVlMC5kcpBnzRpreDLlazPSBZxrg,2605
 clarifai/versions.py,sha256=jctnczzfGk_S3EnVqb2FjRKfSREkNmvNEwAAa_VoKiQ,222
@@ -12,14 +12,14 @@ clarifai/cli/__main__.py~,sha256=ozwaF8wYiURORkuFhk0_wsDPUYZjH547Wz9eVk-4nro,70
 clarifai/cli/base.py,sha256=eaUsp7S1e2dslC437Hjk7gUBQsng13ID3N3lkYotB2U,3403
 clarifai/cli/compute_cluster.py,sha256=N2dNQNJEPg9nxsb8x2igEzYuGRzjn7l4kNttjFIxmhI,1827
 clarifai/cli/deployment.py,sha256=sUEuz5-rtozMx8deVcJXLi6lHsP2jc8x3y2MpUAVfqY,2506
-clarifai/cli/model.py,sha256=toRt2fVzVzY5Zhat63jXvRbL_a_MXxrB0f2kmnsH1lM,10179
+clarifai/cli/model.py,sha256=yu4VBm8dNL2al2MrLq7Ohrkx92zRNTh9soLdkwNOKx4,10643
 clarifai/cli/nodepool.py,sha256=yihxS_rIFoBBKzRlqBX8Ab42iPpBMJrJFsk8saph6ms,3049
 clarifai/cli/__pycache__/__init__.cpython-310.pyc,sha256=4ksYQqqaAMCKwyxNsG7hfJGjXDc8y78s9n7AxCEaTQo,160
 clarifai/cli/__pycache__/__main__.cpython-310.pyc,sha256=CM9FOqcSyt-DLnck7FovGDxqT4FPkge7ggq61EsRjjA,250
 clarifai/cli/__pycache__/base.cpython-310.pyc,sha256=a7mN_r511p_Ao8aXrWU9KPSe8wkDZJW4p8UhlD6EoB8,3151
 clarifai/cli/__pycache__/compute_cluster.cpython-310.pyc,sha256=NHLAcVEwqUhci0KB5DpnPWUqXcCttpWrA3F5zld4qN8,1985
 clarifai/cli/__pycache__/deployment.cpython-310.pyc,sha256=AhfbPlwjjj_TmC2UayjuRbNr00dOukDl6NfLhm2rIng,2278
-clarifai/cli/__pycache__/model.cpython-310.pyc,sha256=xJcG8MXZfbbtA1hWxAUxxkNZlQLLvwRWZGZjfA8Pwy4,7649
+clarifai/cli/__pycache__/model.cpython-310.pyc,sha256=Xv9ztIWC9wG2Yx9HB46gcBk6L34zpvQJFeDHmevuXLg,7978
 clarifai/cli/__pycache__/nodepool.cpython-310.pyc,sha256=nEmM-s1HFg7xM5x-bpnqHFWAVLWj0J0ZskYtd6NSq20,2473
 clarifai/client/__init__.py,sha256=xI1U0l5AZdRThvQAXCLsd9axxyFzXXJ22m8LHqVjQRU,662
 clarifai/client/app.py,sha256=6pckYme1urV2YJjLIYfeZ-vH0Z5YSQa51jzIMcEfwug,38342
@@ -129,10 +129,10 @@ clarifai/runners/__pycache__/__init__.cpython-310.pyc,sha256=fDW5OMOxp7N8ZekWweA
 clarifai/runners/__pycache__/server.cpython-310.pyc,sha256=a6yFsRHEWmPhlvVlBx4AhsOms7Q4If62hhmldpW_d6Q,3644
 clarifai/runners/dockerfile_template/Dockerfile.debug,sha256=sRlfRmSLE_TiLORcVRx-3-B0vvSNeUYgm0CCrWmLvAA,667
 clarifai/runners/dockerfile_template/Dockerfile.debug~,sha256=7YOVg3adIaiudfSkfLGeyxt-FfIBbD3UIIYccrIVJTs,426
-clarifai/runners/dockerfile_template/Dockerfile.template,sha256=WiHYYy3FG7yUqhWET7AmbjgGfjZae5n06EEIVVdKVVo,3157
+clarifai/runners/dockerfile_template/Dockerfile.template,sha256=L2SSEBqkJcOtf02r0jrH1nzjcgVB0eRYx2gDLBU2iEs,3171
 clarifai/runners/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/runners/models/base_typed_model.py,sha256=0QCWxch8CcyJSKvE1D4PILd2RSnQZHTmx4DXlQQ6dpo,7856
-clarifai/runners/models/model_builder.py,sha256=mQ0bmoJYrhMAcYYIQVx9Z76dn0d4AeEMZhjxxQUwaCw,31445
+clarifai/runners/models/model_builder.py,sha256=f3OS6mnDAWf4PvugCrED4-deAA0ea7y06ZDtdUKmfoI,32004
 clarifai/runners/models/model_class.py,sha256=9JSPAr4U4K7xI0kSl-q0mHB06zknm2OR-8XIgBCto94,1611
 clarifai/runners/models/model_run_locally.py,sha256=den2rmw7gDS7VIssz7cpoSDzPdw0yunLnmxPv0jiEbs,20638
 clarifai/runners/models/model_runner.py,sha256=PyxwK-33hLlhkD07tTXkjWZ_iNlZHl9_8AZ2W7WfExI,6097
@@ -140,7 +140,7 @@ clarifai/runners/models/model_servicer.py,sha256=jtQmtGeQlvQ5ttMvVw7CMnNzq-rLkTa
 clarifai/runners/models/model_upload.py,sha256=VjJgNNBPP9O7LkNCXxOqa0lTW1M7k6XKVyI6XlLdXIc,25095
 clarifai/runners/models/__pycache__/__init__.cpython-310.pyc,sha256=GTFjzypyx5wnDGqxYeY01iya1CELKb5fOFBFLV031yU,171
 clarifai/runners/models/__pycache__/base_typed_model.cpython-310.pyc,sha256=CubexZ9Ie7mrZcER8LE9V_KKESZgXZJS_JYxq5kYYMg,8271
-clarifai/runners/models/__pycache__/model_builder.cpython-310.pyc,sha256=hU4pJdo_hUb-5urGGnUz8uPVL5XO30HYv3-u7kXwvRg,25797
+clarifai/runners/models/__pycache__/model_builder.cpython-310.pyc,sha256=Y0KPtyrWfsToC3xLd36owymVdHueO_MbxmeYDizrcBM,25834
 clarifai/runners/models/__pycache__/model_class.cpython-310.pyc,sha256=OxOQDH4G_XXvXCOChWLjONFVcDWdr6T00JjQvKx1AgA,1889
 clarifai/runners/models/__pycache__/model_run_locally.cpython-310.pyc,sha256=35VGAU78qM0T6pVmIoHNhIe0pWrU5JOQtNF7xwp8wGE,17073
 clarifai/runners/models/__pycache__/model_runner.cpython-310.pyc,sha256=OqkMwm5-oq9oOJOBaFWscG_yDOPXsZl3cpvZOnP8hMI,4964
@@ -148,7 +148,7 @@ clarifai/runners/models/__pycache__/model_servicer.cpython-310.pyc,sha256=w5kENn
 clarifai/runners/models/__pycache__/model_upload.cpython-310.pyc,sha256=erkIUHtJv1ohMOFT8EAJuVfBsEY4o0GxpeXrZqjrfGk,21046
 clarifai/runners/utils/#const.py#,sha256=H47gAAI93H0juXaz5dAXg2mPF5SmCxP8GXXVDVe49DU,929
 clarifai/runners/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clarifai/runners/utils/const.py,sha256=KEtqkn7wGDyGKVGf6J9S9Eb3P5y-7M7Pb7I2yEEs4EI,928
+clarifai/runners/utils/const.py,sha256=xnPeVuUHQ1K-LoEfhLCmzOV6UQoPS1jqDqQJ5h0IvPU,1024
 clarifai/runners/utils/data_handler.py,sha256=sxy9zlAgI6ETuxCQhUgEXAn2GCsaW1GxpK6GTaMne0g,6966
 clarifai/runners/utils/data_utils.py,sha256=R1iQ82TuQ9JwxCJk8yEB1Lyb0BYVhVbWJI9YDi1zGOs,318
 clarifai/runners/utils/loader.py,sha256=SgNHMwRmCCymFQm8aDp73NmIUHhM-N60CBlTKbPzmVc,7470
@@ -186,9 +186,9 @@ clarifai/workflows/__pycache__/__init__.cpython-310.pyc,sha256=oRKg6B7Z-wWQy0EW2
 clarifai/workflows/__pycache__/export.cpython-310.pyc,sha256=cNmGLnww7xVpm4htd1vRhQJoEZ1dhpN1oD8iLLAtVzM,2418
 clarifai/workflows/__pycache__/utils.cpython-310.pyc,sha256=rm2kWk4a3GOKWoerXpEAEeRvGhEe7wPd0ZZ6jHtEGqY,1925
 clarifai/workflows/__pycache__/validate.cpython-310.pyc,sha256=QA1i6YdDpY824cqtQvkEaFPpaCa2iqfOwFouqwZfAKY,2139
-clarifai-11.1.4rc1.dist-info/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
-clarifai-11.1.4rc1.dist-info/METADATA,sha256=QYbAz_rKw2JiHOdxp03xapBKPWl4oiTKsdZZjS8LNHI,22198
-clarifai-11.1.4rc1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-clarifai-11.1.4rc1.dist-info/entry_points.txt,sha256=X9FZ4Z-i_r2Ud1RpZ9sNIFYuu_-9fogzCMCRUD9hyX0,51
-clarifai-11.1.4rc1.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
-clarifai-11.1.4rc1.dist-info/RECORD,,
+clarifai-11.1.4rc2.dist-info/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
+clarifai-11.1.4rc2.dist-info/METADATA,sha256=ATJvWHHlwjNR80XlRNvonuRfPNoznpqZlgcbpkMYNas,22198
+clarifai-11.1.4rc2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+clarifai-11.1.4rc2.dist-info/entry_points.txt,sha256=X9FZ4Z-i_r2Ud1RpZ9sNIFYuu_-9fogzCMCRUD9hyX0,51
+clarifai-11.1.4rc2.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
+clarifai-11.1.4rc2.dist-info/RECORD,,