Skip to content

Commit

Permalink
updated several pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Alfrick committed Jan 19, 2024
1 parent 59fb0c2 commit 444a363
Show file tree
Hide file tree
Showing 29 changed files with 100 additions and 30 deletions.
44 changes: 29 additions & 15 deletions docs/clarifai-basics/applications/application-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,18 @@ sidebar_position: 2

You can change the settings of an application at any time. To do so, go to the application's individual page and select the **Settings** option on the collapsible left sidebar.

You'll be redirected to the **App Settings** page, where you can change the application's settings.
You'll be redirected to the **Settings** page, where you can change the application's settings.

![app settings](/img/edit_application.jpg)

Let's talk about the changes you can make on the page.

:::note

This page has intuitive elements that let you search for specific items and sort displayed items based on your preferences.

:::

## API Keys

### Create API Keys
Expand All @@ -24,7 +30,7 @@ Click the **Create API Key** button to add a new API key to your app. Then, use

![api keys](/img/application_settings_1.png)

The new key will be listed in the **API Keys** section, where you can carry out various management tasks on it.
The new [app-specific key](https://docs.clarifai.com/clarifai-basics/authentication/app-specific-api-keys) will be listed in the **API Keys** section, where you can carry out various management tasks on it.

### Copy an API Key

Expand Down Expand Up @@ -76,42 +82,50 @@ A Base Workflow is the workflow you choose as the default knowledge base when cr

You can change your app's base workflow by selecting another one from the list that drops down when you click the workflows search box. You can choose public workflows or workflows you've created in your app.

:::info

Updating the base workflow will re-index your app, processing all inputs through the new base workflow. This may take some time, and could incur costs. You could avoid the costs by deleting all your inputs before updating the base workflow.

:::

After selecting your preferred Base Workflow, click the **Change Base Workflow** button.

![change base workflow](/img/application_settings_8.png)

:::warning

Performing the actions below is dangerous. So, you need to proceed with caution.
Performing any of the actions below is dangerous. So, you need to proceed with caution.

:::

## Transfer Application
## Update Visibility

You can transfer your application to an organization you belong to and have permission to create apps. This would greatly enhance collaboration and boost your productivity.
You can easily toggle your app's visibility between private and public modes by clicking the **Update Visibility** button.

To do so, click the **Transfer** button. On the small window that pops up, select the app’s destination organization and give it a new name, if you want to.
![update visibility](/img/application_settings_update_visibility.png)

Click the **Confirm** button to finalize the transfer.
## Delete Application

![transfer application](/img/application_settings_9.png)
You can delete the application by clicking the **Delete App** button. A small window will pop up, prompting you to confirm the action.

The app will be successfully moved to the organization you selected, and it will no longer appear under your listed apps.
![delete app](/img/application_settings_11.png)

Remember that once you delete an application, we cannot recover it. You will also lose all images, concepts, models, and other resources associated with that application.

## Delete all Models

You can delete all models by clicking the **Delete all Models** button. A small window will pop up, prompting you to confirm the action.

![delete all models](/img/application_settings_10.png)

## Delete Application

You can delete the application by clicking the **Delete App** button. A small window will pop up, prompting you to confirm the action.

![delete app](/img/application_settings_11.png)
## Transfer Application

Remember that once you delete an application, we cannot recover it. You will also lose all images, concepts, models, and other resources associated with that application.
You can transfer your application to an [organization](https://docs.clarifai.com/portal-guide/clarifai-organizations/) you belong to and have permission to create apps. This would greatly enhance collaboration and boost your productivity.

To do so, click the **Transfer** button. On the small window that pops up, select the app’s destination organization and give it a new name, if you want to.

Click the **Confirm** button to finalize the transfer.

![transfer application](/img/application_settings_9.png)

The app will be successfully moved to the organization you selected, and it will no longer appear under your listed apps.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ A PAT allows you to make inferences on resources that are outside the scope of y

## How to Create a PAT on the Portal

To create a new PAT, [log in](https://clarifai.com/login) to the portal, navigate to the upper right-hand section of the navigation bar, and click your user’s profile icon.
A default PAT is automatically generated for you when you create an account on the Clarifai portal. Nonetheless, you can also create a new PAT explicitly on the portal.

To create it, [log in](https://clarifai.com/login) to the portal, navigate to the upper right-hand section of the navigation bar, and click your user’s profile icon.

Select the **Security** settings option on the drop-down list.

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/langchain/text-embeddings.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ Here is how you can create text embeddings.

:::info

You can explore the [LangChain documentation](https://api.python.langchain.com/en/latest/embeddings/langchain.embeddings.clarifai.ClarifaiEmbeddings.html#langchain.embeddings.clarifai.ClarifaiEmbeddings) to learn more on how to use the framework with Clarifai for text embedding tasks.
You can explore the [LangChain documentation](https://python.langchain.com/docs/integrations/text_embedding/clarifai) to learn more on how to use the framework with Clarifai for text embedding tasks.

:::
2 changes: 1 addition & 1 deletion docs/portal-guide/clarifai-organizations/members-teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can track the invitations on the **Pending Invitations** section of the page

:::info

Every user is currently limited to one organization only. So, a user can only belong to one organization at a time. If you’ve invited an existing Clarifai user who already belongs to another organization, they will need to exit their current one before joining yours.
We offer a multi-org membership functionality. Users can create, join, and engage with multiple organizations. A user’s membership is not limited to only one organization at any given time.

:::

Expand Down
36 changes: 32 additions & 4 deletions docs/portal-guide/model/agent-system-operators/tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,45 @@ sidebar_position: 8
**Learn about our tracker operators**
<hr />

## Centroid Tracker
Tracker operators are a specific type of agent system operators that are designed for object tracking in computer vision. Object tracking involves following the movement of objects in a sequence of images or frames in a video. Tracker models are trained using machine learning techniques to learn patterns and features that help them identify and track objects over time.

**Output**: Regions
The goal of object tracking is to maintain the identity of the object(s) over time, despite changes in position, scale, orientation, and lighting conditions.

Centroid trackers rely on the Euclidean distance between centroids of regions in different video frames to assign the same track ID to detections of the same object.
:::tip

Since the tracker operators can be "chained" together with models to automate tasks in a workflow, you can learn how to create workflows [here](https://docs.clarifai.com/portal-guide/workflows/input-nodes#create-your-workflow).

:::

## BYTE Tracker

**Output**: Regions

Supports BYTE tracking
[BYTE Tracker](https://arxiv.org/abs/2110.06864) is a multi-object tracking by-detection model built upon the [Simple Online and Real-time Tracking](https://arxiv.org/abs/1602.00763) (SORT) principles. Multi-object tracking aims to predict the bounding boxes and identities of objects within video sequences.

With this operator, you can seamlessly integrate object tracking into your detect-track workflows, unlocking advanced capabilities.

Let's demonstrate how you can use the BYTE Tracker, alongside [a detection model](https://docs.clarifai.com/portal-guide/model/model-types/visual-detector), to efficiently track objects in videos.

**1.** Go to the workflow builder. Search for the **visual-detector** option in the left-hand sidebar and drag it onto the empty workspace. Then, use the pop-up that appears on the right-hand sidebar to search for a detection model, such as [general-image-detection](https://clarifai.com/clarifai/main/models/general-image-detection), and select its version. You can also set the other configuration options—including selecting the concepts you want to filter.

**2.** Search for the **byte-tracker** option in the left-hand sidebar and drag it onto the workspace. You can set up the parameters for it.

**3.** Connect the **visual-detector** model with the **byte-tracker** operator and save your workflow.

![](/img/agent-system-operators/byte_tracker_1.png)

To observe it in action, navigate to the workflow's individual page and click the **+** button to input your video. For this example, let's provide [this video](https://samples.clarifai.com/kep_CLIP_20180509-114253.mp4).

The workflow will analyze the video and identify objects consistently throughout its duration.

![](/img/agent-system-operators/byte_tracker_2.png)

## Centroid Tracker

**Output**: Regions

Centroid trackers rely on the Euclidean distance between centroids of regions in different video frames to assign the same track ID to detections of the same object.

## Neural Tracker

Expand Down
42 changes: 34 additions & 8 deletions docs/portal-guide/portal-overview.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
---
description: Your platform for the entire AI-lifecycle
description: Your platform for the entire AI lifecycle
sidebar_position: 1
---

# Clarifai Portal Basics

**Your portal for the entire AI-lifecycle**
**Your full-stack platform for the entire AI lifecycle**
<hr />

The Clarifai Community portal is the fastest and easiest AI workspace for any skill level. It has everything you need to build reliable AI-powered apps. With the low-code, no-code solution, you can discover, build, and share futuristic AI models, workflows, and app components.

![](/img/community_2/homepage.png)
The Clarifai's full-stack portal is the fastest and easiest AI workspace for any skill level. It has everything you need to build reliable AI-powered apps. With the low-code, no-code solution, you can discover, build, and share futuristic AI models, workflows, and app components.

It gives you the power to search, sort, and organize your AI projects right out of the box. Its intuitive, feature-rich, drag-and-drop user interface makes the world’s most advanced computer vision AI technology accessible to anyone.

:::note
:::info

Note that anything that you can do on the platform, you can also do directly with our API. If you want to build powerful UIs, you can do so with our [API](https://docs.clarifai.com/api-guide/api-overview/).
Anything that you can do on the platform, you can also do directly with our API. If you want to build powerful UIs, you can do so with our [API](https://docs.clarifai.com/api-guide/api-overview/).

:::

Community offers powerful tools for the full AI lifecycle. It provides a seamless, end-to-end AI workspace that you can use to manage your data, annotate your inputs, and build custom AI models.
Our platform offers powerful tools for the full AI lifecycle. It provides a seamless, end-to-end AI workspace that you can use to manage your data, annotate your inputs, and build custom AI models.

![](/img/community_2/general_image_recognition_model.png)

Expand All @@ -32,3 +30,31 @@ The Clarifai Community platform provides the following:
- Ability to easily filter and sort resources by name, type, license, data, and more as an extensible model, data, workflow, and UI catalog.
- Ability to collaborate with AI experts from all over the world. You'll get the right tools to collaborate in the public community and within your organization. This lets you accelerate your AI adoption efforts.

## Search

![](/img/community_2/search_community_resources.png)

<br />

You can effortlessly find what you need by searching through your own and Community resources—apps, models, workflows, and modules. This is how we treat searches:

- Multiple-word queries function as an "OR" (e.g., "face detection" yields results with both "face" and "detection").
- Dashes (-) are treated as spaces since spaces aren't allowed in resource IDs.
- Partial-word searches, such as "fac," return results containing relevant terms like "face-detection."

All resources are searchable by:

- **Resource ID**—you can provide a unique identifier of a particular resource.
- **User ID**—you can provide a unique identifier assigned to an individual user.
- **Short description**—you can provide a brief summary that provides key information about what you're looking for.
- **Markdown notes**—you can perform text-based searches within the markdown notes of any resource. If you input any text in the search field, the results will include any relevant information where the search phrase is found within the markdown notes. This feature enhances search functionality and allows for more precise and context-aware discovery of resources based on the content within their markdown notes.

## Starring

You can mark any resource—be it your own or publicly accessible in the Community—as a favorite. Simply click the star icon to designate any resource, including apps, models, datasets, workflows, and modules, as your favorite.

You can access your favorite resources by navigating to the top-right menu bar and selecting the "Starred" option. If you choose the "All" option, you'll get a list encompassing both starred and unstarred resources.

You can also organize your starred resources by sorting them in either descending order (highest number of stars first) or ascending order (lowest number of stars first) according to your preference.

![](/img/community_2/starring_resources.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/application_settings_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/community_2/homepage.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/community_2/starring_resources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/edit_application.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/others/leaderboard_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/others/leaderboard_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/others/leaderboard_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/others/leaderboard_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/others/leaderboard_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 444a363

Please sign in to comment.