Skip to content

Commit

Permalink
docs review
Browse files Browse the repository at this point in the history
  • Loading branch information
sr-remsha committed Sep 25, 2024
1 parent 360a5dd commit 0b2693f
Show file tree
Hide file tree
Showing 23 changed files with 63 additions and 14 deletions.
4 changes: 4 additions & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Follow this tutorial to launch AI DIAL Chat with Echo application. As a result, you will be able to access Chat on http://localhost:3000/ and use Echo application to mirror your prompts.

> * To learn more, watch a [demo video](../video%20demos/demos-for-developers/deploy-ollama) to see how to deploy a chat application with a self-hosted model.
> * Refer to other quick start instructions in [Tutorials](./tutorials/quick-start-with-application).

## Prerequisites

1. Docker engine (Docker Compose Version 2.20.0 +) installed on your machine. Refer to [Docker](https://docs.docker.com/desktop/) documentation.
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/enable-publications.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

You can publish/unpublish conversations and prompts, or even a collection of those, making them accessible within your organization. Additionally, you can manage access to the published resources, ensuring that the right information is accessible to the right individuals or teams.

> Watch [Publications](../video%20demos/demos/dial-publications) demo video to learn more about collaboration features in AI DIAL.
## DIAL API

Refer to [AI DIAL API](https://epam-rail.com/dial_api#tag/Publications) to view publications endpoints.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/multimodality.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For audio/video-to-text tasks, AI DIAL has adapters for Gemini 1.5 Pro and Flash

### Applications

You can use [DIAL SDK](https://github.com/epam/ai-dial-sdk) to create custom applications, which are basically any custom logic with a conversation interface packaged as a ready-to-use solution. Refer to [Tutorials](./quick-start-with-application) to learn how to create a simple application or watch a [demo video](../video%20demos/demos-for-developers/dial-develop-and-deploy).
You can use [DIAL SDK](https://github.com/epam/ai-dial-sdk) to create custom applications, which are basically any custom logic with a conversation interface packaged as a ready-to-use solution. Refer to [Tutorials](./quick-start-with-application) to learn how to create a simple application or watch a [demo video](../video%20demos/demos-for-developers/develop-application).

Such application can be designed and configured to use multimodal LLMs to perform specific tasks or even form an ecosystem of applications that can interact with each other.

Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/quick-start-with-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

From this tutorial, you will learn how to create and deploy a simple Echo application for AI DIAL Chat. Echo application mirrors all user prompts.

> Watch a [demo video](../video%20demos/demos-for-developers/develop-application) to see in action how to develop a simple application.
> Take note that this document covers the most basic aspects of developing and testing AI DIAL applications. Deploying and distributing these applications for production purposes will require additional configurations that guarantee secure access to the application endpoints through the implementation of firewalls and other network security settings to prevent unauthorized intrusion to the deployed applications.
## About AI DIAL Extension Framework
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/quick-start-with-self-hosted-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

In this tutorial, you will learn how to quickly launch AI DIAL Chat with a self-hosted model powered by [Ollama](https://ollama.com/).

> Watch a [demo video](../video%20demos/demos-for-developers/deploy-ollama) to see it in action.
## Prerequisites

Docker engine installed on your machine (Docker Compose Version 2.20.0 +).
Expand Down
15 changes: 13 additions & 2 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

AI DIAL Chat is a powerful enterprise-grade application that serves as a default web interface for users, providing access to the full set of AI DIAL features.

> Watch a [demo video](../video%20demos/demos/dial-ui-basics) with introduction to AI DIAL Chat UI.
> * Watch a [demo video](../video%20demos/demos/dial-ui-basics) with introduction to AI DIAL Chat UI.
> * Refer to [Quick Start](quick-start) to learn how to launch AI DIAL Chat in a few clicks.
### Additional Documentation

Expand Down Expand Up @@ -134,6 +135,8 @@ In the conversation header, you can view the current settings, change settings (

You can share a conversation or a folder with several conversations with other users. Yo can also receive a shared conversation.

> Watch [Collaboration](../video%20demos/demos/dial-collaboration) demo video to learn more about sharing and other collaboration features in AI DIAL.
**To receive a shared conversation**:

When someone shared a conversation with you, you can find it in the **Shared with me** section in the left panel.
Expand Down Expand Up @@ -321,7 +324,9 @@ As you can see on the picture above, the system creates two conversations with t

You can publish conversations to make them available for the target audience.

**Note**: to publish a shared conversation, [duplicate](#duplicate) it and then publish.
> Watch [Publications](../video%20demos/demos/dial-publications) demo video to learn more about collaboration features in AI DIAL.
> **Note**: to publish a shared conversation, [duplicate](#duplicate) it and then publish.
**To publish a conversation**:

Expand Down Expand Up @@ -518,6 +523,8 @@ Also, you can use a *selection* mode to choose prompt(s) you want to delete:

You can share a prompt or a folder with several prompts with other users.

> Watch [Collaboration](../video%20demos/demos/dial-collaboration) demo video to learn more about sharing and other collaboration features in AI DIAL.
**To Receive a Shared Prompt**:

To obtain a prompt from someone else (receive a shared prompt), you must get a link from them. By clicking on this link, you will import the prompt into your chat.
Expand Down Expand Up @@ -579,6 +586,8 @@ When importing a **duplicate** of an existing prompt, you will be asked to selec

You can publish prompts to make them available for the target audience.

> Watch [Publications](../video%20demos/demos/dial-publications) demo video to learn more about collaboration features in AI DIAL.
> **Note**: to publish a shared prompt, [duplicate](#duplicate-1) it and then publish.
**To publish a prompt**:
Expand Down Expand Up @@ -920,6 +929,8 @@ Click a folder to expand it.

You can publish/unpublish conversations and prompts, or even a collection of those, making them accessible within your organization. Additionally, you can manage access to the published resources, ensuring that the right information is accessible to the right individuals or teams.

> Watch [Publications](../video%20demos/demos/dial-publications) demo video to learn more about collaboration features in AI DIAL.
### Configuration

> Refer to [tutorials](/tutorials/enable-publications#dial-chat) to learn more about working and configuring publications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
https://youtu.be/vE6mLwR6IGM

This video contains step-by-step instructions to deploy DIAL from [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-zx4u372lqvtfi). It is intended as a "test" installation for educational purposes, and lacks many of the enterprise features available from the main GitHub repository.

> Refer to [AI DIAL Helm](https://github.com/epam/ai-dial-helm/blob/main/charts/dial/examples/aws/complete/README.md) repository to AWS installation documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
https://youtu.be/PV02IUqLo1c

This video contains step-by-step instructions to deploy DIAL from [Google Cloud Marketplace (GCP)](https://console.cloud.google.com/marketplace/product/epam-mp-dial/epam-ai-dial). The listing automatically creates the service accounts with necessary roles, and launches the VM for you with a pre-configured instance of DIAL leveraging the models available in Vertex AI (PaLM, Gemini, Imagen, and Gemini Vision). It is intended as a "test" installation for educational purposes, and lacks many of the enterprise features available from the main GitHub repository.

> Refer to [AI DIAL Helm](https://github.com/epam/ai-dial-helm/blob/main/charts/dial/examples/gcp/complete/README.md) repository to GCP installation documentation.
8 changes: 8 additions & 0 deletions docs/video demos/demos-for-developers/4.deploy-ollama.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Deploy DIAL with Ollama

https://youtu.be/uRUzvSmtkeI

In this tutorial, we will be deploying AI DIAL from GitHub and launching it with AI DIAL Chat and vision models from Ollama. We will take a look at the DIAL Configuration files and outline how to connect models and applications to AI DIAL. In the [part 2](develop-application), we will be developing a simple text translator application.

> * Refer to [Tutorials](../../tutorials/quick-start-with-self-hosted-model) to lean how to launch AI DIAL Chat with a self-hosted model.
> * Refer to [Supported Models](../../supported-models) to view the list of models supported in AI DIAL.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Develop Translator App

https://youtu.be/xG7ilq9oeMA

In Part 2 of this series ([watch Part 1](deploy-ollama)), will be using our DIAL Deployment with Ollama to develop a simple text translator. We will go through the process of updating the DIAL config and setting up applications to talk to DIAL core.

> * Refer to [Tutorials](../../tutorials/quick-start-with-self-hosted-model) to lean how to launch AI DIAL Chat with a self-hosted model.
> * Refer to [Tutorials](../../tutorials/quick-start-with-application) to lean how to launch AI DIAL Chat with a simple Echo application.
> * Refer to [Supported Models](../../supported-models) to view the list of models supported in AI DIAL.
2 changes: 1 addition & 1 deletion docs/video demos/demos/2.dial-ui-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ https://youtu.be/W5fpFW7XDn4

Out of the box, AI DIAL's UI allows you to utilize features like parameterized prompts, import/export conversations, replay conversations with different models, compare different models and simultaneously ask them questions, and playback conversations for demos.

Refer to [AI DIAL Chat user guide](../../user-guide) to learn more.
> Refer to [AI DIAL Chat user guide](../../user-guide) to learn more.
2 changes: 1 addition & 1 deletion docs/video demos/demos/3.dial-roles-and-rate-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ https://youtu.be/VWpn7M0bXaQ

AI DIAL allows you to define roles and rate limits to restrict access to certain models or applications based on your organizational structure. This allows you to control costs and ensure data and applications are protected within your organization. Access Control applies both on the Chat UI level and through programmatic access via the API.

Refer to [Roles & Access Control](../../Roles%20and%20Access%20Control/overview) to learn more.
> Refer to [Roles & Access Control](../../Roles%20and%20Access%20Control/overview) to learn more.
2 changes: 1 addition & 1 deletion docs/video demos/demos/4.interceptors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ https://youtu.be/h10E14kXlOI

Interceptors are DIAL's solution to Responsible AI and Guardrails. Interceptors can be seen as middleware that facilitate implementation of custom logic to modify incoming or outgoing requests. In practice, we use interceptors to facilitate the implementation of a Responsible AI approach and enforce compliance with internal and external privacy regulations and policies.

Refer to [Interceptors](../../tutorials/interceptors) to learn more.
> Refer to [Interceptors](../../tutorials/interceptors) to learn more.
6 changes: 4 additions & 2 deletions docs/video demos/demos/5.dial-collaboration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Collaboration in DIAL
# Collaboration

https://youtu.be/ywmzhAuFMaI

There are three distinct features in DIAL related to collaboration within your organization: Share, Export and Publish. Each has its pros and cons, and this video highlights the main similarities and differences within the three. Export creates files that allows you to create moment-in-time snapshots of conversations to share across environments. Share creates a reference to an existing conversation that you can send to colleagues that will update as you continue the conversation. Publications allow you to create a prompt or conversation library that is automatically shared with colleagues along the organization structure.
There are three distinct features in DIAL related to collaboration within your organization: [Share](../../user-guide#share), [Export](../../user-guide#export) and [Publish](../../tutorials/enable-publications). Each has its pros and cons, and this video highlights the main similarities and differences within the three. Export creates files that allows you to create moment-in-time snapshots of conversations to share across environments. Share creates a reference to an existing conversation that you can send to colleagues that will update as you continue the conversation. Publications allow you to create a prompt or conversation library that is automatically shared with colleagues along the organization structure.

> Watch [Publications](dial-publications) demo video to learn more about collaboration features in AI DIAL.
8 changes: 8 additions & 0 deletions docs/video demos/demos/6.dial-publications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Publications

https://youtu.be/GxdhfWLspa0

Publications allow users to publish and share resources such as conversations, prompts, files, or applications within their organization. These resources can be made accessible to specific individuals or teams by managing access rights. The publication process involves sending a publication request, which is then reviewed and either approved or declined by an administrator. Once approved, the published resources become available to the target audience. Resource owners also have the ability to unpublish resources if needed. Publications also support detailed version history, allowing users to update existing publications without overwriting them.

> * Refer to [Publications](../../tutorials/enable-publications) to learn more about publications and other collaboration features.
> * Watch a [Collaboration](dial-collaboration) video to learn more about other collaboration features in AI DIAL.
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion docs/video demos/demos/animated-scatterplot.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

https://youtu.be/t8MBktPJZDY

In this video, we will take a look at a quick example of a conversation with StatGPT where we collect statistics about GDP Per Capita, Labor Force, and Unemployment Rate, and create an Animated Scatterplot using AI Code Generation and the Plotly library.
In this video, we will take a look at a quick example of a conversation with StatGPT where we collect statistics about GDP Per Capita, Labor Force, and Unemployment Rate, and create an Animated Scatterplot using AI Code Generation and the Plotly library.

> Refer to [Data Visualization](../../tutorials/data-visualization) to learn more about data visualization capabilities of AI DIAL.

0 comments on commit 0b2693f

Please sign in to comment.