Skip to content

Commit

Permalink
added table of contents and other small chnages to Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adithyan-sukumar committed Oct 30, 2023
1 parent 8900ee2 commit a06ca90
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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}
Expand Down

0 comments on commit a06ca90

Please sign in to comment.