From a06ca909a198b7adcbc1da5079e1c2c81680713f Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 13:55:51 +0530 Subject: [PATCH 01/12] added table of contents and other small chnages to Readme.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 05f59843..57daf5fa 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,31 @@ This is the official Python client for interacting with our powerful [API](https --- + + +##Table Of Contents + +**[1. Installation](#installation)** +**[2. Getting Started](#getting-started)** +**[3. Interacting with Datasets](#interacting-with-datasets)** +**[4. Interacting with Inputs](#interacting-with-inputs)** +* [4.1 Input upload](#input-upload) +* [4.2 Input listing](#input-listing) + +**[5. Interacting with Models](#interacting-with-models)** +* [5.1 Workflow Predict](#workflow-predict) +* [5.2 Workflow Listing](#workflows-listing) +* [5.3 Workflow Create](#workflow-create) +* [5.4 Workflow Export](#workflow-export) + +**[6. More Examples](#more-examples)** + + + + + + + ## Installation @@ -49,8 +74,17 @@ pip3 install -r requirements.txt ## Getting started Clarifai uses **Personal Access Tokens(PATs)** to validate requests. You can create and manage PATs under your Clarifai account security settings. +[Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) +* ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** + + Export your PAT as an environment variable. Then, import and initialize the API Client. +[Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) + +* ***Log into Portal → Profile Icon → Account → Profile → User-ID*** + +Set PAT as environment variable through terminal: ```cmd export CLARIFAI_PAT={your personal access token} From 41130fa497177d35ed2f70b1815f479e53aed137 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 16:31:47 +0530 Subject: [PATCH 02/12] Made Create PAT and Get UserID as bullet points --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 57daf5fa..ec9f7194 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ This is the official Python client for interacting with our powerful [API](https -##Table Of Contents +## Table Of Contents **[1. Installation](#installation)** **[2. Getting Started](#getting-started)** @@ -74,16 +74,13 @@ pip3 install -r requirements.txt ## Getting started Clarifai uses **Personal Access Tokens(PATs)** to validate requests. You can create and manage PATs under your Clarifai account security settings. -[Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) -* ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** +* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** +
+* [Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) ***Log into Portal → Profile Icon → Account → Profile → User-ID*** Export your PAT as an environment variable. Then, import and initialize the API Client. -[Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) - -* ***Log into Portal → Profile Icon → Account → Profile → User-ID*** - Set PAT as environment variable through terminal: ```cmd From f7077131511c05bd643d1529c627f8c07721985a Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 16:42:29 +0530 Subject: [PATCH 03/12] added new line inbetween ToC sections 1 to 4 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ec9f7194..5348d157 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,10 @@ This is the official Python client for interacting with our powerful [API](https ## Table Of Contents -**[1. Installation](#installation)** -**[2. Getting Started](#getting-started)** -**[3. Interacting with Datasets](#interacting-with-datasets)** -**[4. Interacting with Inputs](#interacting-with-inputs)** +**[1. Installation](#installation)** \ +**[2. Getting Started](#getting-started)** \ +**[3. Interacting with Datasets](#interacting-with-datasets)** \ +**[4. Interacting with Inputs](#interacting-with-inputs)** * [4.1 Input upload](#input-upload) * [4.2 Input listing](#input-listing) From 2af60615fb78d70c927bed8d788637bdc0cce60a Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 16:54:03 +0530 Subject: [PATCH 04/12] added new line inbetween ToC sections 1 to 4 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5348d157..62fd0fed 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This is the official Python client for interacting with our powerful [API](https **[1. Installation](#installation)** \ **[2. Getting Started](#getting-started)** \ **[3. Interacting with Datasets](#interacting-with-datasets)** \ -**[4. Interacting with Inputs](#interacting-with-inputs)** +**[4. Interacting with Inputs](#interacting-with-inputs)** * [4.1 Input upload](#input-upload) * [4.2 Input listing](#input-listing) From 52896e30639a8ac54f05484c44c511e95d41db70 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 16:55:44 +0530 Subject: [PATCH 05/12] removed newline between bullet points --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 62fd0fed..8d1cea7e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This is the official Python client for interacting with our powerful [API](https **[1. Installation](#installation)** \ **[2. Getting Started](#getting-started)** \ **[3. Interacting with Datasets](#interacting-with-datasets)** \ -**[4. Interacting with Inputs](#interacting-with-inputs)** +**[4. Interacting with Inputs](#interacting-with-inputs)** * [4.1 Input upload](#input-upload) * [4.2 Input listing](#input-listing) @@ -74,8 +74,7 @@ pip3 install -r requirements.txt ## Getting started Clarifai uses **Personal Access Tokens(PATs)** to validate requests. You can create and manage PATs under your Clarifai account security settings. -* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** -
+* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** * [Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) ***Log into Portal → Profile Icon → Account → Profile → User-ID*** From a12e8c0cf8d0e562d9fd58aa9ba18063f3bb9354 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 17:59:54 +0530 Subject: [PATCH 06/12] fixed spellings and changed numbers to bullet points --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8d1cea7e..7c6a36d8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Clarifai Python SDK -This is the official Python client for interacting with our powerful [API](https://docs.clarifai.com). The Clarifai Python SDK offers a comprehensive set of tools to integrate Clarifai's AI platform to leverage computer vision capabiities like classification , detection ,segementation and natural language capabilities like classification , summarisation , generation , Q&A ,etc into your applications. With just a few lines of code, you can leverage cutting-edge artificial intelligence to unlock valuable insights from visual and textual content. +This is the official Python client for interacting with our powerful [API](https://docs.clarifai.com). The Clarifai Python SDK offers a comprehensive set of tools to integrate Clarifai's AI platform to leverage computer vision capabilities like classification , detection ,segementation and natural language capabilities like classification , summarisation , generation , Q&A ,etc into your applications. With just a few lines of code, you can leverage cutting-edge artificial intelligence to unlock valuable insights from visual and textual content. [Website](https://www.clarifai.com/) | [Demo](https://clarifai.com/demo) | [Signup for a Free Account](https://clarifai.com/signup) | [API Docs](https://docs.clarifai.com/) | [Clarifai Community](https://clarifai.com/explore) | [Python SDK Docs](https://docs.clarifai.com/python-sdk/api-reference) | [Examples](https://github.com/Clarifai/examples) | [Colab Notebooks](https://github.com/Clarifai/colab-notebooks) @@ -29,20 +29,20 @@ This is the official Python client for interacting with our powerful [API](https ## Table Of Contents -**[1. Installation](#installation)** \ -**[2. Getting Started](#getting-started)** \ -**[3. Interacting with Datasets](#interacting-with-datasets)** \ -**[4. Interacting with Inputs](#interacting-with-inputs)** -* [4.1 Input upload](#input-upload) -* [4.2 Input listing](#input-listing) +* **[Installation](#installation)** +* **[Getting Started](#getting-started)** +* **[Interacting with Datasets](#interacting-with-datasets)** +* **[Interacting with Inputs](#interacting-with-inputs)** + * [Input Upload](#input-upload) + * [Input Listing](#input-listing) -**[5. Interacting with Models](#interacting-with-models)** -* [5.1 Workflow Predict](#workflow-predict) -* [5.2 Workflow Listing](#workflows-listing) -* [5.3 Workflow Create](#workflow-create) -* [5.4 Workflow Export](#workflow-export) +* **[Interacting with Models](#interacting-with-models)** + * [Workflow Predict](#workflow-predict) + * [Workflow Listing](#workflows-listing) + * [Workflow Create](#workflow-create) + * [Workflow Export](#workflow-export) -**[6. More Examples](#more-examples)** +* **[More Examples](#more-examples)** @@ -74,7 +74,7 @@ pip3 install -r requirements.txt ## Getting started Clarifai uses **Personal Access Tokens(PATs)** to validate requests. You can create and manage PATs under your Clarifai account security settings. -* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** +* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** * [Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) ***Log into Portal → Profile Icon → Account → Profile → User-ID*** @@ -123,7 +123,7 @@ Dataset().export(save_path='output.zip', local_archive_path='clarifai-data-proto ### Interacting with Inputs -#### Input upload +#### Input Upload ```python # Note: CLARIFAI_PAT must be set as env variable. from clarifai.client.user import User @@ -140,7 +140,7 @@ input_obj.upload_from_file(input_id = 'demo', video_file='demo.mp4') input_obj.upload_text(input_id = 'demo', raw_text = 'This is a test') ``` -#### Input listing +#### Input Listing ```python #listing inputs input_generator = input_obj.list_inputs(page_no=1,per_page=10,input_type='image') From 9a27c39cfe82c1f33cd885c22d20ca58cf045c93 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Mon, 30 Oct 2023 20:02:02 +0530 Subject: [PATCH 07/12] lint fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c6a36d8..d5aa284d 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,9 @@ This is the official Python client for interacting with our powerful [API](https ## Table Of Contents -* **[Installation](#installation)** -* **[Getting Started](#getting-started)** -* **[Interacting with Datasets](#interacting-with-datasets)** +* **[Installation](#installation)** +* **[Getting Started](#getting-started)** +* **[Interacting with Datasets](#interacting-with-datasets)** * **[Interacting with Inputs](#interacting-with-inputs)** * [Input Upload](#input-upload) * [Input Listing](#input-listing) From 15a915a944b8c42a8dedf75abe5ab7cf2c77cdac Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Tue, 31 Oct 2023 15:09:33 +0530 Subject: [PATCH 08/12] added few more descriptions --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d5aa284d..356b6a03 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,6 @@ This is the official Python client for interacting with our powerful [API](https * **[Interacting with Inputs](#interacting-with-inputs)** * [Input Upload](#input-upload) * [Input Listing](#input-listing) - * **[Interacting with Models](#interacting-with-models)** * [Workflow Predict](#workflow-predict) * [Workflow Listing](#workflows-listing) @@ -50,7 +49,7 @@ This is the official Python client for interacting with our powerful [API](https -## Installation +## 🚀 Installation Install from PyPi: @@ -71,12 +70,12 @@ pip3 install -r requirements.txt -## Getting started +## :memo: Getting started Clarifai uses **Personal Access Tokens(PATs)** to validate requests. You can create and manage PATs under your Clarifai account security settings. -* [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** +* 🔗 [Create PAT:](https://docs.clarifai.com/clarifai-basics/authentication/personal-access-tokens/) ***Log into Portal → Profile Icon → Security Settings → Create Personal Access Token → Set the scopes → Confirm*** -* [Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) ***Log into Portal → Profile Icon → Account → Profile → User-ID*** +* 🔗 [Get User ID:](https://help.clarifai.com/hc/en-us/articles/4408131912727-How-do-I-find-my-user-id-app-id-and-PAT-) ***Log into Portal → Profile Icon → Account → Profile → User-ID*** Export your PAT as an environment variable. Then, import and initialize the API Client. @@ -96,7 +95,8 @@ apps_generator = client.list_apps() apps = list(apps_generator) ``` -### Interacting with Datasets +### 💾 Interacting with Datasets +Clarifai datasets help in managing datasets used for model training and evaluation. It provides functionalities like creating datasets,uploading datasets and exporting datasets as .zip files. ```python # Note: CLARIFAI_PAT must be set as env variable. @@ -121,7 +121,8 @@ Dataset().export(save_path='output.zip', local_archive_path='clarifai-data-proto ``` -### Interacting with Inputs +### ⌨️ Interacting with Inputs +You can use ***inputs()*** for adding and interacting with input data. Inputs can be uploaded directly from a URL or a file. You can also view input annotations and concepts. #### Input Upload ```python @@ -155,8 +156,8 @@ all_concepts = list(app.list_concepts()) ``` -### Interacting with Models - +### 🥁 Interacting with Models +Using Clarifai models, you can choose any models by provding model URL or ID to perform prediction and list all available models. It is also possible to modify model prediction outcomes by adding threshold. #### Model Predict ```python # Note: CLARIFAI_PAT must be set as env variable. @@ -196,7 +197,8 @@ all_llm_community_models = App().list_models(filter_by={"query": "LLM", all_llm_community_models = list(all_llm_community_models) ``` -### Interacting with Workflows +### 🔥 Interacting with Workflows +Using ***Workflow()***, you can interact with Calrifai workflows in many ways. It allows prediction and modification of inference thresholds to get desirable results. Creating and exporting of workflows can be done using local ***yaml*** file. #### Workflow Predict ```python @@ -248,6 +250,6 @@ workflow = Workflow("https://clarifai.com/clarifai/main/workflows/Demographics") workflow.export('demographics_workflow.yml') ``` -## More Examples +## 📌 More Examples See many more code examples in this [repo](https://github.com/Clarifai/examples). Also see the official [Python SDK docs](https://clarifai-python.readthedocs.io/en/latest/index.html) From 6de7a9884c03ed6a4662d2e5e583bdf717badb6c Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Tue, 31 Oct 2023 15:11:33 +0530 Subject: [PATCH 09/12] removed spacing --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 356b6a03..10694cdd 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,6 @@ This is the official Python client for interacting with our powerful [API](https * [Workflow Listing](#workflows-listing) * [Workflow Create](#workflow-create) * [Workflow Export](#workflow-export) - * **[More Examples](#more-examples)** @@ -96,7 +95,7 @@ apps = list(apps_generator) ``` ### 💾 Interacting with Datasets -Clarifai datasets help in managing datasets used for model training and evaluation. It provides functionalities like creating datasets,uploading datasets and exporting datasets as .zip files. +Clarifai datasets help in managing datasets used for model training and evaluation. It provides functionalities like creating datasets,uploading datasets and exporting datasets as .zip files. ```python # Note: CLARIFAI_PAT must be set as env variable. @@ -157,7 +156,7 @@ all_concepts = list(app.list_concepts()) ### 🥁 Interacting with Models -Using Clarifai models, you can choose any models by provding model URL or ID to perform prediction and list all available models. It is also possible to modify model prediction outcomes by adding threshold. +Using Clarifai models, you can choose any models by provding model URL or ID to perform prediction and list all available models. It is also possible to modify model prediction outcomes by adding threshold. #### Model Predict ```python # Note: CLARIFAI_PAT must be set as env variable. From 976a06c321e87d62876bd71fb3c5f27ec6216cf6 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Tue, 31 Oct 2023 16:37:00 +0530 Subject: [PATCH 10/12] made changes on sizing and descriptions --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 10694cdd..5c45a82b 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ apps_generator = client.list_apps() apps = list(apps_generator) ``` -### 💾 Interacting with Datasets +## 💾 Interacting with Datasets Clarifai datasets help in managing datasets used for model training and evaluation. It provides functionalities like creating datasets,uploading datasets and exporting datasets as .zip files. ```python @@ -120,7 +120,7 @@ Dataset().export(save_path='output.zip', local_archive_path='clarifai-data-proto ``` -### ⌨️ Interacting with Inputs +## 💾 Interacting with Inputs You can use ***inputs()*** for adding and interacting with input data. Inputs can be uploaded directly from a URL or a file. You can also view input annotations and concepts. #### Input Upload @@ -155,8 +155,9 @@ all_concepts = list(app.list_concepts()) ``` -### 🥁 Interacting with Models -Using Clarifai models, you can choose any models by provding model URL or ID to perform prediction and list all available models. It is also possible to modify model prediction outcomes by adding threshold. +## 🥁 Interacting with Models +The **Model** Class allows you to perform predictions using Clarifai models. You can specify which model to use by providing the model URL or ID. This gives you flexibility in choosing models. The **App** Class also allows listing of all available Clarifai models for discovery. +For greater control over model predictions, you can pass in an `output_config` to modify the model output as demonstrated below. #### Model Predict ```python # Note: CLARIFAI_PAT must be set as env variable. @@ -196,8 +197,9 @@ all_llm_community_models = App().list_models(filter_by={"query": "LLM", all_llm_community_models = list(all_llm_community_models) ``` -### 🔥 Interacting with Workflows -Using ***Workflow()***, you can interact with Calrifai workflows in many ways. It allows prediction and modification of inference thresholds to get desirable results. Creating and exporting of workflows can be done using local ***yaml*** file. +## 🔥 Interacting with Workflows +Workflows offer a versatile framework for constructing the inference pipeline, simplifying the integration of diverse models. You can use the **Workflow** class to create and manage workflows using **YAML** configuration. +For starting or making quick adjustments to existing Clarifai community workflows using an initial YAML configuration, the SDK provides an export feature. #### Workflow Predict ```python From ce73cb443995f7f95934a1f60e330996dd4a4ed6 Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Tue, 31 Oct 2023 17:00:51 +0530 Subject: [PATCH 11/12] lint fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c45a82b..2a455db7 100644 --- a/README.md +++ b/README.md @@ -156,8 +156,8 @@ all_concepts = list(app.list_concepts()) ## 🥁 Interacting with Models -The **Model** Class allows you to perform predictions using Clarifai models. You can specify which model to use by providing the model URL or ID. This gives you flexibility in choosing models. The **App** Class also allows listing of all available Clarifai models for discovery. -For greater control over model predictions, you can pass in an `output_config` to modify the model output as demonstrated below. +The **Model** Class allows you to perform predictions using Clarifai models. You can specify which model to use by providing the model URL or ID. This gives you flexibility in choosing models. The **App** Class also allows listing of all available Clarifai models for discovery. +For greater control over model predictions, you can pass in an `output_config` to modify the model output as demonstrated below. #### Model Predict ```python # Note: CLARIFAI_PAT must be set as env variable. From c54371cc8b480da4a60cac8df8be5e3b63c5c9bf Mon Sep 17 00:00:00 2001 From: adithyan sukumar Date: Fri, 3 Nov 2023 14:34:22 +0530 Subject: [PATCH 12/12] fixed table of contents --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2a455db7..4fadab9c 100644 --- a/README.md +++ b/README.md @@ -29,18 +29,21 @@ This is the official Python client for interacting with our powerful [API](https ## Table Of Contents -* **[Installation](#installation)** -* **[Getting Started](#getting-started)** -* **[Interacting with Datasets](#interacting-with-datasets)** -* **[Interacting with Inputs](#interacting-with-inputs)** +* **[Installation](#rocket-installation)** +* **[Getting Started](#memo-getting-started)** +* **[Interacting with Datasets](#floppy_disk-interacting-with-datasets)** +* **[Interacting with Inputs](#floppy_disk-interacting-with-inputs)** * [Input Upload](#input-upload) * [Input Listing](#input-listing) -* **[Interacting with Models](#interacting-with-models)** +* **[Interacting with Models](#brain-interacting-with-models)** + * [Model Predict](#model-predict) + * [Model Listing](#models-listing) +* **[Interacting with Workflows](#fire-interacting-with-workflows)** * [Workflow Predict](#workflow-predict) * [Workflow Listing](#workflows-listing) * [Workflow Create](#workflow-create) * [Workflow Export](#workflow-export) -* **[More Examples](#more-examples)** +* **[More Examples](#pushpin-more-examples)** @@ -48,7 +51,7 @@ This is the official Python client for interacting with our powerful [API](https -## 🚀 Installation +## :rocket: Installation Install from PyPi: @@ -94,7 +97,7 @@ apps_generator = client.list_apps() apps = list(apps_generator) ``` -## 💾 Interacting with Datasets +## :floppy_disk: Interacting with Datasets Clarifai datasets help in managing datasets used for model training and evaluation. It provides functionalities like creating datasets,uploading datasets and exporting datasets as .zip files. ```python @@ -120,7 +123,7 @@ Dataset().export(save_path='output.zip', local_archive_path='clarifai-data-proto ``` -## 💾 Interacting with Inputs +## :floppy_disk: Interacting with Inputs You can use ***inputs()*** for adding and interacting with input data. Inputs can be uploaded directly from a URL or a file. You can also view input annotations and concepts. #### Input Upload @@ -155,7 +158,7 @@ all_concepts = list(app.list_concepts()) ``` -## 🥁 Interacting with Models +## :brain: Interacting with Models The **Model** Class allows you to perform predictions using Clarifai models. You can specify which model to use by providing the model URL or ID. This gives you flexibility in choosing models. The **App** Class also allows listing of all available Clarifai models for discovery. For greater control over model predictions, you can pass in an `output_config` to modify the model output as demonstrated below. #### Model Predict @@ -197,7 +200,7 @@ all_llm_community_models = App().list_models(filter_by={"query": "LLM", all_llm_community_models = list(all_llm_community_models) ``` -## 🔥 Interacting with Workflows +## :fire: Interacting with Workflows Workflows offer a versatile framework for constructing the inference pipeline, simplifying the integration of diverse models. You can use the **Workflow** class to create and manage workflows using **YAML** configuration. For starting or making quick adjustments to existing Clarifai community workflows using an initial YAML configuration, the SDK provides an export feature. @@ -251,6 +254,6 @@ workflow = Workflow("https://clarifai.com/clarifai/main/workflows/Demographics") workflow.export('demographics_workflow.yml') ``` -## 📌 More Examples +## :pushpin: More Examples See many more code examples in this [repo](https://github.com/Clarifai/examples). Also see the official [Python SDK docs](https://clarifai-python.readthedocs.io/en/latest/index.html)