clarifai 10.8.4__py3-none-any.whl → 10.8.6__py3-none-any.whl

{clarifai-10.8.4.dist-info → clarifai-10.8.6.dist-info}/RECORD

@@ -1,11 +1,11 @@
-clarifai/__init__.py,sha256=HSKp-CWoewa1bRsD-uVM7lGOdBh9yxh5X4Qc8hkw9ak,23
+clarifai/__init__.py,sha256=5gJxqMyHfStgLsUbgDyNI4zTcQbFwffphiPw6fZhAHk,23
 clarifai/cli.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/errors.py,sha256=RwzTajwds51wLD0MVlMC5kcpBnzRpreDLlazPSBZxrg,2605
 clarifai/versions.py,sha256=jctnczzfGk_S3EnVqb2FjRKfSREkNmvNEwAAa_VoKiQ,222
 clarifai/client/__init__.py,sha256=xI1U0l5AZdRThvQAXCLsd9axxyFzXXJ22m8LHqVjQRU,662
 clarifai/client/app.py,sha256=VC5TqeYVNUyENPxOOKNSAl0q3ivPiqg-gtRr77ACIIM,38424
 clarifai/client/base.py,sha256=JXbbjg2CXo8rOdw-XgKWWtLVAhPv3OZua5LFT5w4U2Q,7380
-clarifai/client/dataset.py,sha256=XX-J-9Ict1CQrEycq-JbdxUTuucSgLeDSvnlHE1ucQY,29903
+clarifai/client/dataset.py,sha256=AmkeYdZI7oe7ZCEh4odTuzC5r4ESCmkdHHo4v23dSeQ,30204
 clarifai/client/input.py,sha256=ZLqa1jGx4NgCbunOTpJxCq4lDQ5xAf4GQ0rsZY8AHCM,44456
 clarifai/client/lister.py,sha256=03KGMvs5RVyYqxLsSrWhNc34I8kiF1Ph0NeyEwu7nMU,2082
 clarifai/client/model.py,sha256=YqeCwk1v_Rs2L6OTZSkDZvxGaxMoFMYuxVV7s9jdd0I,74416
@@ -17,7 +17,7 @@ clarifai/client/auth/__init__.py,sha256=7EwR0NrozkAUwpUnCsqXvE_p0wqx_SelXlSpKShK
 clarifai/client/auth/helper.py,sha256=hqwI7Zlsvivc-O9aAdtxyJT3zkpuMvbxjRaiCTsWYGk,14183
 clarifai/client/auth/register.py,sha256=2CMdBsoVLoTfjyksE6j7BM2tiEc73WKYvxnwDDgNn1k,536
 clarifai/client/auth/stub.py,sha256=xy4-fV0W8keCgXld4eOVzFQEIKxOktNwtL5bLztReug,4940
-clarifai/constants/dataset.py,sha256=Puz6_FfTm30G5FVBb1GJsobMkNtbg0Y2Soy7eyHjvtI,587
+clarifai/constants/dataset.py,sha256=vjK3IlgXu31HycuvjRSzEQSqhU6xfj5TIgo6IpyUWoc,609
 clarifai/constants/input.py,sha256=WcHwToUVIK9ItAhDefaSohQHCLNeR55PSjZ0BFnoZ3U,28
 clarifai/constants/model.py,sha256=Um1hLfMFlh5R_vtP3Z6P-o6zon-tdbLcKVIl4PucrV4,438
 clarifai/constants/rag.py,sha256=WcHwToUVIK9ItAhDefaSohQHCLNeR55PSjZ0BFnoZ3U,28
@@ -27,10 +27,11 @@ clarifai/datasets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU
 clarifai/datasets/export/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/datasets/export/inputs_annotations.py,sha256=7c6HWdATI4aPCRoCPZetUBNNEz9dBhbyYX1QqX-xYe4,9744
 clarifai/datasets/upload/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clarifai/datasets/upload/base.py,sha256=IP4sdBRfThk2l0W1rDWciFrAJnKwVsM-gu4zEslJ2_E,2198
-clarifai/datasets/upload/features.py,sha256=oq0PGpAw8LEafiSkdMMl0yn-NJeZ7K_CKzpJ71b0H40,1731
-clarifai/datasets/upload/image.py,sha256=pNFTThEVGIK9RNIsUuSSQE59LfO-tKkhsXSR7CONAEg,8293
-clarifai/datasets/upload/text.py,sha256=KM_LupAqYYxmbl1Q5nTsr3eV1RAYDfr-2xzf4cP6rfY,2083
+clarifai/datasets/upload/base.py,sha256=UIc0ufyIBCrb83_sFpv21L8FshsX4nwsLYQkdlJfzD4,2357
+clarifai/datasets/upload/features.py,sha256=jv2x7jGZKS-LMt87sEZNBwwOskHbP26XTMjoiaSA5pg,2024
+clarifai/datasets/upload/image.py,sha256=HlCsfEMu_C4GVecGSv52RUJ6laLW8H64Pfj_FQyX6qg,8580
+clarifai/datasets/upload/multimodal.py,sha256=2_s4SCotzacVMdnqkM7upSR3Ovxh3b9oW1hSWhKyxO4,2373
+clarifai/datasets/upload/text.py,sha256=boVJenfQZKf79aXu8CEP4g_ANzX5ROdd06g07O7RnXU,2198
 clarifai/datasets/upload/utils.py,sha256=h7mtN9FZXhQQbf47EXczgb-NTY2uOE9AJlE9u4-hDwI,9627
 clarifai/datasets/upload/loaders/README.md,sha256=aNRutSCTzLp2ruIZx74ZkN5AxpzwKOxMa7OzabnKpwg,2980
 clarifai/datasets/upload/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -40,50 +41,6 @@ clarifai/datasets/upload/loaders/imagenet_classification.py,sha256=LuylazxpI5V8f
 clarifai/datasets/upload/loaders/xview_detection.py,sha256=hk8cZdYZimm4KOaZvBjYcC6ikURZMn51xmn7pXZT3HE,6052
 clarifai/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/models/api.py,sha256=d3FQQlG0mNDLrfEvchqaVcq4Tgb_TqryNnJtwp3c7sE,10961
-clarifai/models/model_serving/README.md,sha256=zXnKybVoIF_LYHKKY2vijTCaGcb2-GJ5kef2uB1WFrs,4241
-clarifai/models/model_serving/__init__.py,sha256=78fiK9LvdGvpMxICmZWqSIyS6BFATjW2s5R6_GgtbPA,645
-clarifai/models/model_serving/constants.py,sha256=8eVT6iYGRF4s4SKoHFUmDwCX6C2EiEiCOP1MIgtcc6A,692
-clarifai/models/model_serving/utils.py,sha256=vdFLyxvcDJhgFdw2jaOsVNVmLlw87ymGTgQachVleOU,1089
-clarifai/models/model_serving/cli/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
-clarifai/models/model_serving/cli/_utils.py,sha256=CZTKKiaoO1Mg5MKQS2Qhgy4JRjnkEHqy8zY5U6b6C0w,1734
-clarifai/models/model_serving/cli/base.py,sha256=k4ARNU1koNzGAi9ach6Vpk7hpISZySiYHyKjkBLuHLg,283
-clarifai/models/model_serving/cli/build.py,sha256=-C4PBt-9xO9YsyUagz3kF4J0_PsYb6YVKFY8y-VmY5I,2786
-clarifai/models/model_serving/cli/clarifai_clis.py,sha256=sGDDj7MrlU3goWLQm4H9dCf4lPD2Ojx50_jdIoxb5QM,663
-clarifai/models/model_serving/cli/create.py,sha256=wtKcVi8XSPN-Fx0RrSUxEwH1hm5TbZ_FrCEMIS9yszM,5598
-clarifai/models/model_serving/cli/example_cli.py,sha256=tCm0J4EI0kuuSRhEiPTuraSA-bUYwtEFEHcL1eOXzRI,1039
-clarifai/models/model_serving/cli/login.py,sha256=IQHL3SdERThnCTGPp5HnI41B0-BTzzGb2wx0P8-KIIA,771
-clarifai/models/model_serving/cli/upload.py,sha256=kOz8OOEobo6sLUkS1xg0672PTmMkx0aWxjKMhSRlMwM,7013
-clarifai/models/model_serving/docs/cli.md,sha256=fLgyY8sYMPjYQW_q8Q9yJYB_ryDVGbzj2VouJgvkEFw,4564
-clarifai/models/model_serving/docs/concepts.md,sha256=ppQADibKQInf9JpfcH7wIpcMndTZ3618or5yzMhGNOE,9376
-clarifai/models/model_serving/docs/dependencies.md,sha256=apwg_IxDBzovtQYXRpWMU9pUqdf0VaS10yMVOYYXhoc,728
-clarifai/models/model_serving/docs/inference_parameters.md,sha256=EFBQs3OGQNH512zoLJKMfFD6WXE_Tzt_Uvts877VvpQ,4111
-clarifai/models/model_serving/docs/model_types.md,sha256=3sALugeBTMspEnlPNWXI8xtWCxjMDQYjrAji_jgqHVo,1013
-clarifai/models/model_serving/model_config/__init__.py,sha256=MLnCl4U2UlL8hkvKbKifFX2nKRjVN63687-gxiKf8g4,734
-clarifai/models/model_serving/model_config/base.py,sha256=Jow6cFvREtWRaaXw1hobWJks0uYsOi9oL973ZPEfIkk,14636
-clarifai/models/model_serving/model_config/config.py,sha256=EWkPcui370QEYJAjlzuLupLlaZF2BgFbK0Jhx_JDHnk,10188
-clarifai/models/model_serving/model_config/inference_parameter.py,sha256=fDPRkwsntaGZWQWOiCW8x0tcyHPeSCYZwBZoZb2oBzw,3924
-clarifai/models/model_serving/model_config/output.py,sha256=uyXY-B9mmoe8lizTpYEBRYI1KDNQh3ihEiEB4Ne65uc,4634
-clarifai/models/model_serving/model_config/model_types_config/multimodal-embedder.yaml,sha256=4wFQ2R8PiJrXR_8AEgUDD-22gY9sK93y9r68mSOOVnw,541
-clarifai/models/model_serving/model_config/model_types_config/text-classifier.yaml,sha256=0hicyQM-R2Za62RaBexdNCkHBDdacwMRVAL8Yk_sVzs,421
-clarifai/models/model_serving/model_config/model_types_config/text-embedder.yaml,sha256=MEnVsO3-SAOFSW7-b0BOSxgUNxdhXfmE98hXstBt104,395
-clarifai/models/model_serving/model_config/model_types_config/text-to-image.yaml,sha256=FPO9ic0R_mcFa3nIGon9z3negy1q6LsPRNmJ-wqGhyw,383
-clarifai/models/model_serving/model_config/model_types_config/text-to-text.yaml,sha256=7u_0kdiR2iEuXTKHtErUzZZ8ghUdep-RuWmJd9i8BdY,371
-clarifai/models/model_serving/model_config/model_types_config/visual-classifier.yaml,sha256=UDq-VtnnnhuI7NCJOYM19kFvcMS0aOvDDMSblPk5iYY,468
-clarifai/models/model_serving/model_config/model_types_config/visual-detector.yaml,sha256=cJsalUTzXclXpgzH9CutpWQqseJNg9FrI7WjU3wpfuQ,852
-clarifai/models/model_serving/model_config/model_types_config/visual-embedder.yaml,sha256=OQYdrY81rD3WNooHRkOiQASvL3XfGG9GGzT61jEsrT8,406
-clarifai/models/model_serving/model_config/model_types_config/visual-segmenter.yaml,sha256=mQLwA1JnnvWZwp26lVxzwfhp1GS7hH9yHh7mtOUt9rY,474
-clarifai/models/model_serving/model_config/triton/__init__.py,sha256=uJUjpRauhVp6_9sN5DRQi7bwIKEtHPKyQqcCVj6Aj2g,719
-clarifai/models/model_serving/model_config/triton/serializer.py,sha256=eYwXfaJkeXMaiQq_EDG4vWOCc1CKfnC_U6dSp2Urak0,4278
-clarifai/models/model_serving/model_config/triton/triton_config.py,sha256=mDZafUByvEgM1vd0QZL8nM-cOCqeR-06iOC2T6x8hr4,4696
-clarifai/models/model_serving/model_config/triton/wrappers.py,sha256=-O8t2AEJXvqJlUNtKtr8CUlxLjheV2GfBtM0sB_B1v0,8660
-clarifai/models/model_serving/repo_build/__init__.py,sha256=jFb0RNG4Jh63TH35_Urv0EyNXVMW8FEC2NVHXhlbvqg,673
-clarifai/models/model_serving/repo_build/build.py,sha256=IlJTjt5YI1alAGv1Fw3kPZeh3yqi45R20rKbWN9vV1s,7195
-clarifai/models/model_serving/repo_build/static_files/_requirements.txt,sha256=lIXMfxC4BP6QA5hraObPOwUS3PK9F2mA0Gf8KvlijQE,34
-clarifai/models/model_serving/repo_build/static_files/base_test.py,sha256=Ne5H5JKTQTBuHYl_0g_d5JmUxW7gSECp9te7W1zcVIc,6785
-clarifai/models/model_serving/repo_build/static_files/inference.py,sha256=TejkXZw43mcZD-M9TkfuqMuABz_cliJgf53_Teodtf0,721
-clarifai/models/model_serving/repo_build/static_files/sample_clarifai_config.yaml,sha256=VOFSSb7D_CgRRcqi-plaCH-6hoFO8NAGDNXVSOJGylo,678
-clarifai/models/model_serving/repo_build/static_files/test.py,sha256=GunBqWgTyo0aF5W9ckKz55tGS-wkL9S9TRfytIjB7Eo,1505
-clarifai/models/model_serving/repo_build/static_files/triton/model.py,sha256=l9lkwyeXw9H_K4Om9dGcuylnj4hAlzohspUZkSnQ7Qg,2429
 clarifai/modules/README.md,sha256=mx8pVx6cPp-pP4LcFPT_nX3ngGmhygVK0WiXeD3cbIo,367
 clarifai/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/modules/css.py,sha256=kadCEunmyh5h2yf0-4aysE3ZcZ6qaQcxuAgDXS96yF8,2020
@@ -101,11 +58,11 @@ clarifai/runners/models/base_typed_model.py,sha256=OnAk08Lo2Y1fGiBc6JJ6UvJ8P435c
 clarifai/runners/models/model_class.py,sha256=9JSPAr4U4K7xI0kSl-q0mHB06zknm2OR-8XIgBCto94,1611
 clarifai/runners/models/model_runner.py,sha256=3vzoastQxkGRDK8T9aojDsLNBb9A3IiKm6YmbFrE9S0,6241
 clarifai/runners/models/model_servicer.py,sha256=i10oxz4pb1NsTQwkyhccJ3URg88Qn63XiuoBRCnJn9w,2737
-clarifai/runners/models/model_upload.py,sha256=JlvB9vOiGYVS6xY2i9iMRWD5I4BX8CifNDpJ62Wh-T8,12164
+clarifai/runners/models/model_upload.py,sha256=PsCHO4CsJ2N6kBdeo7uUNjxWooXUgLepW_NfjU_YJ1A,13899
 clarifai/runners/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/runners/utils/data_handler.py,sha256=sxy9zlAgI6ETuxCQhUgEXAn2GCsaW1GxpK6GTaMne0g,6966
 clarifai/runners/utils/data_utils.py,sha256=R1iQ82TuQ9JwxCJk8yEB1Lyb0BYVhVbWJI9YDi1zGOs,318
-clarifai/runners/utils/loader.py,sha256=2U-96wBE8WjtAI978QUWDy4Xkk6j5up8aMAEFVT-VI8,2533
+clarifai/runners/utils/loader.py,sha256=r1FFfN7fE3GXPLOGaJAqmSpwETESkOAVZViOI8IpXNk,2532
 clarifai/runners/utils/logging.py,sha256=xan5ZQH5XHVyNIIjUAQoc_bS3MrjQjEvBYuo0CQKdho,153
 clarifai/runners/utils/url_fetcher.py,sha256=6u7tPRXuBe-4a2LYxRNJ5WTrNMH2kYXsk73Zuo14qb4,1432
 clarifai/schema/search.py,sha256=JjTi8ammJgZZ2OGl4K6tIA4zEJ1Fr2ASZARXavI1j5c,2448
@@ -113,7 +70,7 @@ clarifai/urls/helper.py,sha256=tjoMGGHuWX68DUB0pk4MEjrmFsClUAQj2jmVEM_Sy78,4751
 clarifai/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/utils/constants.py,sha256=MG_iHnSwNEyUZOpvsrTicNwaT4CIjmlK_Ixk_qqEX8g,142
 clarifai/utils/logging.py,sha256=_nzRyXu3fUa_5X8vXig5dV392YkNESDTc3ZoiwVOGZY,11359
-clarifai/utils/misc.py,sha256=WV3KGM5_MwHySVthjUK4O93x6F_kE1h3-xT4zE4EvnU,2150
+clarifai/utils/misc.py,sha256=ptjt1NtteDT0EhrPoyQ7mgWtvoAQ-XNncQaZvNHb0KI,2253
 clarifai/utils/model_train.py,sha256=Mndqy5GNu7kjQHjDyNVyamL0hQFLGSHcWhOuPyOvr1w,8005
 clarifai/utils/evaluation/__init__.py,sha256=PYkurUrXrGevByj7RFb6CoU1iC7fllyQSfnnlo9WnY8,69
 clarifai/utils/evaluation/helpers.py,sha256=d_dcASRI_lhsHIRukAF1S-w7XazLpK9y6E_ug3l50t4,18440
@@ -123,9 +80,9 @@ clarifai/workflows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 clarifai/workflows/export.py,sha256=vICRhIreqDSShxLKjHNM2JwzKsf1B4fdXB0ciMcA70k,1945
 clarifai/workflows/utils.py,sha256=nGeB_yjVgUO9kOeKTg4OBBaBz-AwXI3m-huSVj-9W18,1924
 clarifai/workflows/validate.py,sha256=yJq03MaJqi5AK3alKGJJBR89xmmjAQ31sVufJUiOqY8,2556
-clarifai-10.8.4.dist-info/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
-clarifai-10.8.4.dist-info/METADATA,sha256=hkbzljAgU7J6ey53Lk-70304H-VlkHBD89z68FvJK4Y,19446
-clarifai-10.8.4.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-clarifai-10.8.4.dist-info/entry_points.txt,sha256=qZOr_MIPG0dBBE1zringDJS_wXNGTAA_SQ-zcbmDHOw,82
-clarifai-10.8.4.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
-clarifai-10.8.4.dist-info/RECORD,,
+clarifai-10.8.6.dist-info/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
+clarifai-10.8.6.dist-info/METADATA,sha256=u7wP6djeaOnVhlz_RBIE2aDEretrTZuJWHbfC_UVHpY,19479
+clarifai-10.8.6.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+clarifai-10.8.6.dist-info/entry_points.txt,sha256=qZOr_MIPG0dBBE1zringDJS_wXNGTAA_SQ-zcbmDHOw,82
+clarifai-10.8.6.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
+clarifai-10.8.6.dist-info/RECORD,,

clarifai/models/model_serving/README.md

@@ -1,158 +0,0 @@
-# Clarifai Model Serving
-
-## Overview
-
-Model Serving is a part of user journey at Clarifai offers a user-friendly interface for deploying your local model into production with Clarifai, featuring:
-
-* A convenient command-line interface (CLI)
-* Easy implementation and testing in Python
-* No need for MLops expertise.
-
-## Quickstart Guide
-
-Quick example for deploying a `text-to-text` model
-
-### Initialize a Clarifai model repository
-
-Suppose your working directory name is `your_model_dir`. Then run
-
-```bash
-$ clarifai create model --type text-to-text --working-dir your_model_dir
-$ cd your_model_dir
-```
-
-In `your_model_dir` folder you will see essential files for deployment process
-
-```bash
-your_model_dir
-├── clarifai_config.yaml
-├── inference.py
-├── test.py
-└── requirements.txt
-```
-
-### Implementation
-
-Write your code in class `InferenceModel` which is an interface between your model and Clarifai server in `inference.py`, there are 2 functions you must implement:
-
-* `__init__`: load your model checkpoint once.
-* `predict`: make prediction, called everytime when you make request from API.
-
-For example, a complete implementation of a hf text-generation model
-
-```python
-import os
-from typing import Dict, Union
-from clarifai.models.model_serving.model_config import *
-
-import torch
-from transformers import AutoTokenizer
-import transformers
-
-class InferenceModel(TextToText):
-  """User model inference class."""
-
-  def __init__(self) -> None:
-    """
-    Load inference time artifacts that are called frequently .e.g. models, tokenizers, etc.
-    in this method so they are loaded only once for faster inference.
-    """
-    # current directory
-    self.base_path = os.path.dirname(__file__)
-    # where you save hf checkpoint in your working dir e.i. `your_model_dir`
-    model_path = os.path.join(self.base_path, "checkpoint")
-    self.tokenizer = AutoTokenizer.from_pretrained(model_path)
-    self.pipeline = transformers.pipeline(
-        "text-generation",
-        model=model_path,
-        torch_dtype=torch.float16,
-        device_map="auto",
-    )
-
-  def predict(self, input_data: list,
-              inference_parameters: Dict[str, Union[str, float, int]]) -> list:
-    """ Custom prediction function for `text-to-text` (also called as `text generation`) model.
-
-    Args:
-      input_data (List[str]): List of text
-      inference_parameters (Dict[str, Union[str, float, int]]): your inference parameters
-
-    Returns:
-      list of TextOutput
-
-    """
-    output_sequences = self.pipeline(
-        input_data,
-        eos_token_id=self.tokenizer.eos_token_id,
-        **inference_parameters)
-
-    # wrap outputs in Clarifai defined output
-    return [TextOutput(each[0]) for each in output_sequences]
-```
-
-Update dependencies in `requirements.txt`
-
-```
-clarifai
-torch=2.1.1
-transformers==4.36.2
-accelerate==0.26.1
-```
-
-### Test (optional)
-
-> NOTE: Running `test` is also involved in `build` and `upload` command.
-
-Test and play with your implementation by executing `test.py`.
-
-Install pytest
-
-```bash
-$ pip install pytest
-```
-
-Execute test
-
-```bash
-$ pytest test.py
-```
-
-### Build
-
-Prepare for deployment step. Run:
-
-```bash
-$ clarifai build model
-```
-
-You will obtain `*.clarifai` file, it's simply a zip having all nessecary files in it to get your model work on Clarifai platform.
-
-`NOTE`: you need to upload your built file to cloud storage to get direct download `url` for next step
-
-### Deployment
-
-Login to Clarifai
-
-```bash
-$ clarifai login
-Get your PAT from https://clarifai.com/settings/security and pass it here: <insert your pat here>
-```
-
-Upload
-
-```bash
-# upload built file directly
-$ clarifai upload model <your-working-dir> --user-app <your_user_id>/<your_app_id> --id <your_model_id>
-# or using direct download url of cloud storage
-$ clarifai upload model --url <url> --user-app <your_user_id>/<your_app_id> --id <your_model_id>
-```
-
-## Learn More
-
-* [Detail Instruction](./docs/concepts.md)
-* [Examples](https://github.com/Clarifai/examples/tree/main/model_upload)
-* [Initialize from example](./docs/cli.md)
-* [CLI usage](./docs/cli.md)
-* [Inference parameters](./docs/inference_parameters.md)
-* [Model Types](./docs/model_types.md)
-* [Dependencies](./docs/dependencies.md)

clarifai/models/model_serving/__init__.py

@@ -1,14 +0,0 @@
-# Copyright 2023 Clarifai, Inc.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-from .model_config import *  # noqa
-from .repo_build import *  # noqa

clarifai/models/model_serving/cli/__init__.py

@@ -1,12 +0,0 @@
-# Copyright 2023 Clarifai, Inc.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.

clarifai/models/model_serving/cli/_utils.py

@@ -1,53 +0,0 @@
-from __future__ import annotations  # isort: skip
-import os
-import shutil
-import subprocess
-from typing import Dict, Union
-
-from ..constants import (CLARIFAI_EXAMPLES_REPO, CLARIFAI_EXAMPLES_REPO_PATH,
-                         MODEL_UPLOAD_EXAMPLE_FOLDER)
-
-
-def download_examples_repo(forced_download: bool = False):
-
-  def _pull():
-    subprocess.run(f"git clone {CLARIFAI_EXAMPLES_REPO} {CLARIFAI_EXAMPLES_REPO_PATH}", shell=True)
-
-  if not os.path.isdir(CLARIFAI_EXAMPLES_REPO_PATH):
-    print(f"Download examples to {CLARIFAI_EXAMPLES_REPO_PATH}")
-    _pull()
-  else:
-    if forced_download:
-
-      def _rm_dir_readonly(func, path, _):
-        import stat
-        os.chmod(path, stat.S_IWRITE)
-        func(path)
-
-      print("Removing old examples...")
-      shutil.rmtree(CLARIFAI_EXAMPLES_REPO_PATH, onerror=_rm_dir_readonly)
-      _pull()
-
-
-def list_model_upload_examples(
-    forced_download: bool = False) -> Dict[str, tuple[str, Union[str, None]]]:
-  download_examples_repo(forced_download)
-  model_upload_folder = MODEL_UPLOAD_EXAMPLE_FOLDER
-  model_upload_path = os.path.join(CLARIFAI_EXAMPLES_REPO_PATH, model_upload_folder)
-  examples = {}
-  for model_type_ex in os.listdir(model_upload_path):
-    _folder = os.path.join(model_upload_path, model_type_ex)
-    if os.path.isdir(_folder):
-      _walk = list(os.walk(_folder))
-      if len(_walk) > 0:
-        _, model_names, _files = _walk[0]
-        readme = [item for item in _files if "readme" in item.lower()]
-        for name in model_names:
-          examples.update({
-              f"{model_type_ex}/{name}": [
-                  os.path.join(_folder, name),
-                  os.path.join(_folder, readme[0]) or None
-              ]
-          })
-
-  return examples

clarifai/models/model_serving/cli/base.py

@@ -1,14 +0,0 @@
-from abc import ABC, abstractmethod
-from argparse import _SubParsersAction
-
-
-class BaseClarifaiCli(ABC):
-
-  @staticmethod
-  @abstractmethod
-  def register(parser: _SubParsersAction):
-    raise NotImplementedError()
-
-  @abstractmethod
-  def run(self):
-    raise NotImplementedError()

clarifai/models/model_serving/cli/build.py

@@ -1,79 +0,0 @@
-# Copyright 2023 Clarifai, Inc.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Commandline interface for model upload utils."""
-import argparse
-import os
-import subprocess
-
-from ..repo_build import RepositoryBuilder
-from .base import BaseClarifaiCli
-
-
-class BuildCli(BaseClarifaiCli):
-
-  @staticmethod
-  def register(parser: argparse._SubParsersAction):
-    parser = parser.add_parser("build", help="Build clarifai model for uploading")
-    sub_parser = parser.add_subparsers()
-
-    BuildModelSubCli.register(sub_parser)
-
-    parser.set_defaults(func=BuildCli)
-
-
-class BuildModelSubCli(BaseClarifaiCli):
-
-  @staticmethod
-  def register(parser: argparse._SubParsersAction):
-    sub_parser = parser.add_parser("model", help="Build Clarifai model")
-    sub_parser.add_argument(
-        "path",
-        type=str,
-        nargs='?',
-        help="Path to working directory, default is current directory",
-        default=".")
-    sub_parser.add_argument(
-        "--out-path", type=str, required=False, help="Output path of built model", default=None)
-    sub_parser.add_argument(
-        "--name",
-        type=str,
-        required=False,
-        help="Name of built file, default is `clarifai_model_id` in config if set or `model`",
-        default=None)
-    sub_parser.add_argument(
-        "--no-test",
-        action="store_true",
-        help="Trigger this flag to skip testing before uploading")
-    sub_parser.set_defaults(func=BuildModelSubCli)
-
-  def __init__(self, args: argparse.Namespace) -> None:
-    self.path = args.path
-    self.no_test = args.no_test
-    self.test_path = os.path.join(self.path, "test.py")
-    self.output_path = args.out_path or self.path
-    self.serving_backend = "triton"
-    self.name = args.name
-
-  def run(self):
-
-    # Run test before uploading
-    if not self.no_test:
-      assert os.path.exists(
-          self.test_path), FileNotFoundError(f"Could not find `test.py` in {self.path}")
-      result = subprocess.run(f"pytest -s --log-level=INFO {self.test_path}", shell=True)
-      assert result.returncode == 0, "Test has failed. Please make sure no error exists in your code."
-
-    # build
-    print("Start building...")
-    RepositoryBuilder.build(
-        self.path, backend=self.serving_backend, output_dir=self.output_path, name=self.name)

clarifai/models/model_serving/cli/clarifai_clis.py

@@ -1,33 +0,0 @@
-from argparse import ArgumentParser
-
-from .build import BuildCli
-from .create import CreateCli
-from .example_cli import ExampleCli
-from .login import LoginCli
-from .upload import UploadCli
-
-
-def main():
-
-  parser = ArgumentParser("clarifai")
-  cmd_parser = parser.add_subparsers(help="Clarifai cli helpers")
-
-  UploadCli.register(cmd_parser)
-  CreateCli.register(cmd_parser)
-  LoginCli.register(cmd_parser)
-  ExampleCli.register(cmd_parser)
-  BuildCli.register(cmd_parser)
-
-  args = parser.parse_args()
-
-  if not hasattr(args, "func"):
-    parser.print_help()
-    exit(1)
-
-  # Run
-  service = args.func(args)
-  service.run()
-
-
-if __name__ == "__main__":
-  main()

clarifai/models/model_serving/cli/create.py

@@ -1,171 +0,0 @@
-import os
-import shutil
-from argparse import Namespace, _SubParsersAction
-from typing import List
-
-from InquirerPy import prompt
-
-from ..model_config import MODEL_TYPES
-from ..repo_build import RepositoryBuilder
-from ._utils import list_model_upload_examples
-from .base import BaseClarifaiCli
-
-
-class CreateCli(BaseClarifaiCli):
-
-  @staticmethod
-  def register(parser: _SubParsersAction):
-    creator_parser = parser.add_parser("create", help="Create component of Clarifai platform")
-    sub_creator_parser = creator_parser.add_subparsers()
-
-    SubCreateModelCli.register(sub_creator_parser)
-
-    creator_parser.set_defaults(func=CreateCli)
-
-
-class SubCreateModelCli(BaseClarifaiCli):
-
-  @staticmethod
-  def register(parser: _SubParsersAction):
-    model_parser = parser.add_parser("model")
-    model_parser.add_argument(
-        "--working-dir",
-        type=str,
-        required=True,
-        help="Path to your working dir. Create new dir if it does not exist")
-    model_parser.add_argument(
-        "--from-example",
-        required=False,
-        action="store_true",
-        help="Create repository from example")
-    model_parser.add_argument(
-        "--example-id",
-        required=False,
-        type=str,
-        help="Example id, run `clarifai example list` to list of examples")
-
-    model_parser.add_argument(
-        "--type",
-        type=str,
-        choices=MODEL_TYPES,
-        required=False,
-        help="Clarifai supported model types.")
-    model_parser.add_argument(
-        "--image-shape",
-        nargs='+',
-        type=int,
-        required=False,
-        help="H W dims for models with an image input type. H and W each have a max value of 1024",
-        default=[-1, -1])
-    model_parser.add_argument(
-        "--max-bs", type=int, default=1, required=False, help="Max batch size")
-
-    model_parser.add_argument(
-        "--overwrite", action="store_true", help="Overwrite working-dir if exists")
-
-    model_parser.set_defaults(func=SubCreateModelCli)
-
-  def __init__(self, args: Namespace) -> None:
-    self.working_dir: str = args.working_dir
-    self.from_example = args.from_example
-    self.example_id = args.example_id
-    self.overwrite = args.overwrite
-
-    if os.path.exists(self.working_dir):
-      if self.overwrite:
-        print(f"Overwrite {self.working_dir}")
-      else:
-        raise FileExistsError(
-            f"{self.working_dir} exists. If you want to overwrite it, please set `--overwrite` flag"
-        )
-
-    # prevent wrong args when creating from example
-    if not self.from_example:
-      self.image_shape: List[int] = args.image_shape
-
-      self.type: str = args.type
-      self.max_bs: int = args.max_bs
-
-    else:
-      if not self.example_id:
-        questions = [
-            {
-                "type": "list",
-                "message": "Select an example:",
-                "choices": list_model_upload_examples(),
-            },
-        ]
-        result = prompt(questions)
-        self.example_id = result[0]
-
-      else:
-        available_examples = list(list_model_upload_examples().keys())
-        assert self.example_id in available_examples, f"Available examples are: {available_examples}, got {self.example_id}."
-
-  def run(self):
-    if self.from_example:
-      os.makedirs(self.working_dir, exist_ok=True)
-      model_repo, readme = list_model_upload_examples()[self.example_id]
-      shutil.copytree(model_repo, self.working_dir, dirs_exist_ok=True)
-      if readme:
-        shutil.copy(readme, os.path.join(self.working_dir, "readme.md"))
-
-    else:
-      RepositoryBuilder.init_repository(
-          self.type,
-          self.working_dir,
-          backend="triton",
-          max_batch_size=self.max_bs,
-          image_shape=self.image_shape)
-
-    from itertools import islice
-    from pathlib import Path
-
-    def tree(dir_path: Path,
-             level: int = -1,
-             limit_to_directories: bool = False,
-             length_limit: int = 1000):
-      # prefix components:
-      space = '    '
-      branch = '│   '
-      # pointers:
-      tee = '├── '
-      last = '└── '
-      """Given a directory Path object print a visual tree structure"""
-      dir_path = Path(dir_path)  # accept string coerceable to Path
-      files = 0
-      directories = 0
-
-      def inner(dir_path: Path, prefix: str = '', level=-1):
-        nonlocal files, directories
-        if not level:
-          return  # 0, stop iterating
-        if limit_to_directories:
-          contents = [d for d in dir_path.iterdir() if d.is_dir()]
-        else:
-          contents = list(dir_path.iterdir())
-        pointers = [tee] * (len(contents) - 1) + [last]
-        for pointer, path in zip(pointers, contents):
-          if path.is_dir():
-            yield prefix + pointer + path.name
-            directories += 1
-            extension = branch if pointer == tee else space
-            yield from inner(path, prefix=prefix + extension, level=level - 1)
-          elif not limit_to_directories:
-            yield prefix + pointer + path.name
-            files += 1
-
-      print(dir_path.name)
-      iterator = inner(dir_path, level=level)
-      for line in islice(iterator, length_limit):
-        print(line)
-      if next(iterator, None):
-        print(f'... length_limit, {length_limit}, reached, counted:')
-      print(f'\n{directories} directories' + (f', {files} files' if files else ''))
-
-    print("-" * 75)
-    print(f"* Created repository at: {self.working_dir}")
-    tree(self.working_dir)
-    print()
-    print("* Please make sure your code is tested using `test.py` before uploading")
-    print("-" * 75)