Skip to content

Commit fb7e024

Browse files
authored
[Docs] Reformat README, remove duplicated sections (#3018)
## Description This PR reformats the README and documentation to improve organization, remove duplication, and enhance clarity. Preview: Docs - https://yatarkan.github.io/openvino.genai/docs/getting-started/installation README - https://github.com/yatarkan/openvino.genai/blob/yt/reformat-readme-files/README.md CVS-169351 ## Checklist: - [x] Tests have been updated or added to cover the new code - N/A - [ ] This patch fully addresses the ticket. - [x] I have made corresponding changes to the documentation
1 parent 750700d commit fb7e024

File tree

16 files changed

+101
-585
lines changed

16 files changed

+101
-585
lines changed

README.md

Lines changed: 38 additions & 564 deletions
Large diffs are not rendered by default.

site/docs/getting-started/installation.mdx

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,39 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 2
33
sidebar_label: Installation
44
---
55

66
# Install OpenVINO GenAI
77

8-
OpenVINO GenAI is available for installation via [Archive](https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/), [PyPI](https://pypi.org/project/openvino-genai/)
9-
and [NPM](https://www.npmjs.com/package/openvino-genai-node) distributions and supports Linux, Windows and macOS platforms.
10-
11-
To install OpenVINO GenAI, refer to the [Install Guide](https://docs.openvino.ai/2025/get-started/install-openvino.html).
8+
OpenVINO GenAI is available for installation via [PyPI](https://pypi.org/project/openvino-genai/), [Archive](https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/)
9+
and [npm](https://www.npmjs.com/package/openvino-genai-node) distributions and supports Linux, Windows and macOS platforms.
10+
11+
<Tabs>
12+
<TabItem value="pypi" label="PyPI" default>
13+
```bash
14+
pip install openvino-genai
15+
```
16+
:::info Note
17+
Some models may require additional dependencies.
18+
See the [Model Preparation Guide](/docs/guides/model-preparation/convert-to-openvino) for details.
19+
:::
20+
</TabItem>
21+
<TabItem value="archive" label="Archive">
22+
1. Download [OpenVINO GenAI archive](https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/).
23+
2. Follow the [Archive Installation instructions](https://docs.openvino.ai/2025/get-started/install-openvino/install-openvino-genai.html#archive-installation).
24+
</TabItem>
25+
<TabItem value="npm" label="npm">
26+
```bash
27+
npm install openvino-genai-node
28+
```
29+
See the [Node.js Bindings](/docs/bindings/node-js) for more information.
30+
</TabItem>
31+
</Tabs>
32+
33+
Refer to the [Install Guide](https://docs.openvino.ai/2025/get-started/install-openvino.html) for detailed instructions.
1234

1335
To build OpenVINO GenAI library from source, refer to the [Build Instructions](https://github.com/openvinotoolkit/openvino.genai/blob/master/src/docs/BUILD.md).
1436

15-
To learn more about Node.js bindings, refer to the [Node.js Bindings](/docs/bindings/node-js).
16-
1737
:::info
1838
Please make sure that you are following the versions compatibility rules, refer to the [OpenVINO GenAI Dependencies](#openvino-genai-dependencies) for more information.
1939
:::

site/docs/getting-started/introduction.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,14 @@ Compared to Hugging Face Optimum Intel, OpenVINO GenAI offers a smaller footprin
5656
| Node.js bindings ||||
5757
| Pre-built pipelines ||||
5858
| Model variety | Medium | High | High |
59+
60+
## Additional Resources
61+
62+
- [OpenVINO Generative AI workflow](https://docs.openvino.ai/2025/openvino-workflow-generative.html)
63+
- [Optimum Intel and OpenVINO](https://huggingface.co/docs/optimum/intel/openvino/export)
64+
- [OpenVINO Notebooks with GenAI](https://openvinotoolkit.github.io/openvino_notebooks/?libraries=OpenVINO+GenAI)
65+
66+
Explore blogs to setup your first hands-on experience with OpenVINO GenAI:
67+
68+
- [How to Build OpenVINO™ GenAI APP in C++](https://medium.com/openvino-toolkit/how-to-build-openvino-genai-app-in-c-32dcbe42fa67)
69+
- [How to run Llama 3.2 locally with OpenVINO™](https://medium.com/openvino-toolkit/how-to-run-llama-3-2-locally-with-openvino-60a0f3674549)

site/docs/guides/model-preparation/convert-to-openvino.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For downloading pre-converted models, see [Download Pre-Converted OpenVINO Model
1919

2020
:::info Note
2121
Some models may require additional dependencies.
22-
To convert models with `optimum-cli` and to run the examples, install the dependencies from [`./samples/export-requirements.txt`](https://github.com/openvinotoolkit/openvino.genai/blob/master/samples/export-requirements.txt):
22+
To convert models with `optimum-cli` and to run the examples, install the dependencies from [`./samples/export-requirements.txt`](https://github.com/openvinotoolkit/openvino.genai/blob/master/samples/export-requirements.txt).
2323
:::
2424

2525
```bash

site/docs/use-cases/image-generation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
---
44
import OptimumCLI from '@site/src/components/OptimumCLI';
55
import ConvertModelSection from '../_shared/_convert_model.mdx';

site/docs/use-cases/image-processing/_sections/_run_model/_code_example_cpp.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ int main(int argc, char* argv[]) {
1616
ov::genai::max_new_tokens(100)
1717
);
1818
std::cout << result.texts[0] << std::endl;
19+
20+
// To input videos frames, use 'ov::genai::videos' property, frames tensor layout = [Frame, H, W, C]
21+
// pipe.generate(prompt, ov::genai::videos(std::vector<ov::Tensor>{frames}), ov::genai::max_new_tokens(100));
1922
}
2023
`}
2124
</CodeBlock>

site/docs/use-cases/image-processing/_sections/_run_model/_code_example_python.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,8 @@ images = read_images("./images")
2323
pipe = ov_genai.VLMPipeline(model_path, "${props.device || 'CPU'}")
2424
result = pipe.generate(prompt, images=images, max_new_tokens=100)
2525
print(result.texts[0])
26+
27+
# To input videos frames, use 'videos=', frames tensor layout = [Frame, H, W, C]
28+
# result = pipe.generate(prompt, videos=[frames], max_new_tokens=100)
2629
`}
2730
</CodeBlock>

site/docs/use-cases/image-processing/_sections/_usage_options/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The prompt can contain `<ov_genai_image_i>` with `i` replaced with an actual zer
2828

2929
Model's native video tag can be used to refer to a video. These tags are:
3030
1. LLaVa-NeXT-Video: `<video>`
31+
2. Qwen2-VL: `<|vision_start|><|video_pad|><|vision_end|>`
32+
2. Qwen2.5-VL: `<|vision_start|><|video_pad|><|vision_end|>`
3133

3234
If the prompt doesn't contain image or video tags, but images or videos are provided, the tags are prepended to the prompt.
3335

site/docs/use-cases/image-processing/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 2
33
---
44
import OptimumCLI from '@site/src/components/OptimumCLI';
55
import ConvertModelSection from '../_shared/_convert_model.mdx';

site/docs/use-cases/speech-generation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 5
33
---
44
import OptimumCLI from '@site/src/components/OptimumCLI';
55
import ConvertModelSection from '../_shared/_convert_model.mdx';

0 commit comments

Comments
 (0)