Skip to content

Commit 9790fc6

Browse files
Merge pull request #122 from openvinotoolkit/barabanov/readme-update
Readme update
2 parents ec67902 + dd88d87 commit 9790fc6

File tree

1 file changed

+49
-39
lines changed

1 file changed

+49
-39
lines changed

README.md

Lines changed: 49 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,21 @@
88

99
Get started with OpenVINO™ Test Drive, an application that allows you to run generative AI and vision models trained by [Intel® Geti™](https://docs.geti.intel.com/) directly on your computer or edge device using [OpenVINO™ Runtime](https://github.com/openvinotoolkit/openvino).
1010

11-
1211
<p align="center">
1312
<img src="./docs/llm_model_chat.gif" width="600" alt="sample">
1413
</p>
1514

1615
With use of OpenVINO™ Test Drive you can:
17-
+ **Chat with LLMs** and evaluating model performance on your computer or edge device
18-
+ **Experiment with different text prompts** to generate images using Stable Diffusion and Stable DiffusionXL models
19-
+ **Transcribe speech from video** using Whisper models, including generation of timestamps
20-
+ **Run and visualize results of models** trained by Intel® Geti™ using single image inference or batch inference mode
21-
22-
## Installation
23-
24-
Download the latest release from the [Releases repository](https://storage.openvinotoolkit.org/repositories/openvino_testdrive/).
25-
26-
> [!NOTE]
27-
> To verify downloaded file integrity, you can generate a SHA-256 of the downloaded file and compare it to the SHA-256 from corresponding `.sha256` file published in Releases repository.
28-
29-
### Installation on Windows
30-
31-
> [!IMPORTANT]
32-
> For Intel® NPU, please use the Intel® NPU Driver latest available version.
33-
34-
1. Downloading the zip archive [Releases repository](https://storage.openvinotoolkit.org/repositories/openvino_testdrive/) `Windows` folder .
35-
36-
<p align="left">
37-
<img src="./docs/win_inst.gif" width="500">
38-
</p>
39-
40-
2. Extract zip archive double-click the MSIX installation package, click `Install` button and it will display the installation process
41-
42-
3. Click on the application name on Windows app list to launch OpenVINO™ Test Drive.
43-
4416

45-
## Quick start
17+
- **Chat with LLMs** and evaluating model performance on your computer or edge device
18+
- **Experiment with different text prompts** to generate images using Stable Diffusion and Stable DiffusionXL models
19+
- **Transcribe speech from video** using Whisper models, including generation of timestamps
20+
- **Run and visualize results of models** trained by Intel® Geti™ using single image inference or batch inference mode
4621

47-
Upon starting the application, you can import a model using either Hugging Face for LLMs or upload Intel® Geti™ models from local disk.
22+
## Key features
4823

49-
### Text generation and LLM performance evaluation
24+
<details>
25+
<summary>📝 Text generation and LLM performance evaluation </summary>
5026

5127
1. Choose a model from predefined set of popular models or pick one from Hugging Face using `Import model` -> `Hugging Face` and import it.
5228
<p align="left">
@@ -62,8 +38,10 @@ Upon starting the application, you can import a model using either Hugging Face
6238
<p align="left">
6339
<img src="./docs/metrics.gif" width="500">
6440
</p>
41+
</details>
6542

66-
### Retrieval-Augmented Generation with LLM
43+
<details>
44+
<summary>📚 Retrieval-Augmented Generation with LLM </summary>
6745

6846
1. It is possible to upload files and create knowledge base for RAG (Retrieval-Augmented Generation) using `Knowledge base` tab
6947
<p align="left">
@@ -78,8 +56,10 @@ This knowledge base can be used during text generation with LLM models.
7856
<p align="left">
7957
<img src="./docs/rag2.gif" width="500">
8058
</p>
59+
</details>
8160

82-
### Work with Visual Language Models
61+
<details>
62+
<summary>🧠 Work with Visual Language Models </summary>
8363

8464
1. Try Visual Language Model (VLM) for image analysis.
8565
<p align="left">
@@ -90,8 +70,10 @@ This knowledge base can be used during text generation with LLM models.
9070
<p align="left">
9171
<img src="./docs/vlm2.gif" width="500">
9272
</p>
73+
</details>
9374

94-
### Transcribe speech from video
75+
<details>
76+
<summary>✍️ Transcribe speech from video </summary>
9577

9678
1. Try Whisper for video transcription.
9779
<p align="left">
@@ -105,8 +87,10 @@ This knowledge base can be used during text generation with LLM models.
10587
</p>
10688

10789
3. Use `Performance metrics` tab to get LLM performance metrics on your computer.
90+
</details>
10891

109-
### Image generation
92+
<details>
93+
<summary>🎨 Image generation </summary>
11094

11195
1. Choose an image generation LLM from predefined set of popular models or pick one from Hugging Face using `Import model` -> `Hugging Face` and import it.
11296

@@ -120,9 +104,12 @@ This knowledge base can be used during text generation with LLM models.
120104

121105
You can export LLM via `Export model` button.
122106

123-
### Images inference with models trained by Intel® Geti™
107+
</details>
124108

125-
1. Download code deployment for the model in OpenVINO format trained by Intel® Geti™.
109+
<details>
110+
<summary>🤖 Images inference with models trained by Intel® Geti™ </summary>
111+
112+
1. Download code deployment for the model in OpenVINO format trained by Intel® Geti™.
126113

127114
<p align="left">
128115
<img src="./docs/geti_download.gif" width="500">
@@ -148,6 +135,29 @@ You can export LLM via `Export model` button.
148135
<p align="left">
149136
<img src="./docs/geti_batch.gif" width="500">
150137
</p>
138+
</details>
139+
140+
## Installation
141+
142+
Download the latest release from the [Releases repository](https://storage.openvinotoolkit.org/repositories/openvino_testdrive/).
143+
144+
> [!NOTE]
145+
> To verify downloaded file integrity, you can generate a SHA-256 of the downloaded file and compare it to the SHA-256 from corresponding `.sha256` file published in Releases repository.
146+
147+
### Installation on Windows
148+
149+
> [!IMPORTANT]
150+
> For Intel® NPU, please use the Intel® NPU Driver latest available version.
151+
152+
1. Downloading the zip archive [Releases repository](https://storage.openvinotoolkit.org/repositories/openvino_testdrive/) `Windows` folder .
153+
154+
<p align="left">
155+
<img src="./docs/win_inst.gif" width="500">
156+
</p>
157+
158+
2. Extract zip archive double-click the MSIX installation package, click `Install` button and it will display the installation process
159+
160+
3. Click on the application name on Windows app list to launch OpenVINO™ Test Drive.
151161

152162
## Build
153163

@@ -160,7 +170,7 @@ Secondly, the bindings and its dependencies for your platform to be added to `./
160170

161171
## Ecosystem
162172

163-
- [OpenVINO™](https://github.com/openvinotoolkit/openvino) - software toolkit for optimizing and deploying deep learning models.
173+
- [OpenVINO™](https://github.com/openvinotoolkit/openvino) - software toolkit for optimizing and deploying deep learning models.
164174
- [GenAI Repository](https://github.com/openvinotoolkit/openvino.genai) and [OpenVINO Tokenizers](https://github.com/openvinotoolkit/openvino_tokenizers) - resources and tools for developing and optimizing Generative AI applications.
165175
- [Intel® Geti™](https://docs.geti.intel.com/) - software for building computer vision models.
166176
- [OpenVINO™ Vision ModelAPI](https://github.com/openvinotoolkit/model_api) - a set of wrapper classes for particular tasks and model architectures, simplifying data preprocess and postprocess as well as routine procedures.
@@ -174,4 +184,4 @@ For those who would like to contribute to the OpenVINO™ Test Drive, please che
174184
OpenVINO™ Test Drive repository is licensed under [Apache License Version 2.0](LICENSE).
175185
By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
176186

177-
FFmpeg is an open source project licensed under LGPL and GPL. See https://www.ffmpeg.org/legal.html. You are solely responsible for determining if your use of FFmpeg requires any additional licenses. Intel is not responsible for obtaining any such licenses, nor liable for any licensing fees due, in connection with your use of FFmpeg.
187+
FFmpeg is an open source project licensed under LGPL and GPL. See https://www.ffmpeg.org/legal.html. You are solely responsible for determining if your use of FFmpeg requires any additional licenses. Intel is not responsible for obtaining any such licenses, nor liable for any licensing fees due, in connection with your use of FFmpeg.

0 commit comments

Comments
 (0)