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

clarifai/__init__.py

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

clarifai/cli/model.py

@@ -15,10 +15,13 @@ def model():
     required=True,
     help='Path to the model directory.')
 @click.option(
-    '--download_checkpoints',
-    is_flag=True,
+    '--stage',
+    required=False,
+    type=click.Choice(['runtime', 'build', 'upload'], case_sensitive=True),
+    default="upload",
+    show_default=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".',
+    'The stage we are calling download checkpoints from. Typically this would "upload" and will download checkpoints if config.yaml checkpoints section has when set to "upload". Other options include "runtime" to be used in load_model or "upload" to be used during model upload. Set this stage to whatever you have in config.yaml to force downloading now.'
 )
 @click.option(
     '--skip_dockerfile',
@@ -26,13 +29,9 @@ def model():
     help=
     'Flag to skip generating a dockerfile so that you can manually edit an already created dockerfile.',
 )
-def upload(model_path, download_checkpoints, skip_dockerfile):
+def upload(model_path, stage, skip_dockerfile):
   """Upload a model to Clarifai."""
   from clarifai.runners.models.model_builder import upload_model
-  if download_checkpoints:
-    stage = "any"  # ignore config.yaml and force download now.
-  else:
-    stage = "upload"
   upload_model(model_path, stage, skip_dockerfile)
 
 
@@ -52,12 +51,12 @@ def upload(model_path, download_checkpoints, skip_dockerfile):
 )
 @click.option(
     '--stage',
-    type=str,
     required=False,
+    type=click.Choice(['runtime', 'build', 'upload'], case_sensitive=True),
     default="build",
     show_default=True,
     help=
-    'The stage we are calling download checkpoints from. Typically this would be in the build stage which is the default. Other options include "runtime" to be used in load_model, "upload" to be used during model upload or "any" which will force download now regardless of config.yaml'
+    'The stage we are calling download checkpoints from. Typically this would be in the build stage which is the default. Other options include "runtime" to be used in load_model or "upload" to be used during model upload. Set this stage to whatever you have in config.yaml to force downloading now.'
 )
 def download_checkpoints(model_path, out_path, stage):
   """Download checkpoints from external source to local model_path"""
@@ -67,6 +66,31 @@ def download_checkpoints(model_path, out_path, stage):
   builder.download_checkpoints(stage=stage, checkpoint_path_override=out_path)
 
 
+@model.command()
+@click.option(
+    '--model_path',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the model directory.')
+@click.option(
+    '--out_path',
+    type=click.Path(exists=False),
+    required=False,
+    default=None,
+    help='Path to write the method signature defitions to. If not provided, use stdout.')
+def signatures(model_path, out_path):
+  """Generate method signatures for the model."""
+
+  from clarifai.runners.models.model_builder import ModelBuilder
+  builder = ModelBuilder(model_path, download_validation_only=True)
+  signatures = builder.method_signatures_yaml()
+  if out_path:
+    with open(out_path, 'w') as f:
+      f.write(signatures)
+  else:
+    click.echo(signatures)
+
+
 @model.command()
 @click.option(
     '--model_path',
@@ -172,6 +196,18 @@ def run_locally(model_path, port, mode, keep_env, keep_image):
     click.echo(f"Failed to starts model server locally: {e}", err=True)
 
 
+@model.command()
+@click.option(
+    '--model_path',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the model directory.')
+def local_dev(model_path):
+  """Run the model as a local dev runner to help debug your model connected to the API. You must set several envvars such as CLARIFAI_PAT, CLARIFAI_RUNNER_ID, CLARIFAI_NODEPOOL_ID, CLARIFAI_COMPUTE_CLUSTER_ID. """
+  from clarifai.runners.server import serve
+  serve(model_path)
+
+
 @model.command()
 @click.option(
     '--config',