Skip to content

Commit d19ba91

Browse files
[Docs] Add initial docs pages version (#1765)
Ticket: CVS-158840 Preview: https://yatarkan.github.io/openvino.genai --------- Co-authored-by: Andrei Kochin <andrei.kochin@intel.com>
1 parent 222e2cc commit d19ba91

File tree

102 files changed

+21870
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+21870
-0
lines changed

.github/workflows/deploy_gh_pages.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
workflow_dispatch:
5+
6+
concurrency:
7+
group: 'pages'
8+
cancel-in-progress: true
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
build_assets:
15+
runs-on: ubuntu-22.04
16+
permissions:
17+
contents: write
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
21+
with:
22+
lfs: true
23+
24+
- name: Setup Node.js
25+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
26+
with:
27+
node-version: 20
28+
29+
- name: Install Node.js dependencies
30+
working-directory: ./site
31+
shell: bash
32+
run: npm ci
33+
34+
- name: Build static for GitHub Pages
35+
working-directory: ./site
36+
shell: bash
37+
run: npm run build
38+
39+
- name: Upload pages artifact
40+
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
41+
with:
42+
path: ./site/build
43+
44+
deploy_github_pages:
45+
runs-on: ubuntu-22.04
46+
needs: build_assets
47+
permissions:
48+
pages: write
49+
id-token: write
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

site/.editorconfig

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# http://editorconfig.org
2+
3+
root = false
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
indent_style = space
10+
indent_size = 2
11+
max_line_length = 100
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
insert_final_newline = true
16+
trim_trailing_whitespace = false

site/.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

site/.prettierignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
dist
2+
node_modules
3+
.yarn
4+
build
5+
coverage
6+
.docusaurus
7+
.idea
8+
9+
.svg
10+
*.svg
11+
12+
*.mdx

site/.prettierrc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"printWidth": 100,
3+
"trailingComma": "es5",
4+
"useTabs": false,
5+
"tabWidth": 2,
6+
"semi": true,
7+
"bracketSpacing": true,
8+
"singleQuote": true,
9+
"arrowParens": "always"
10+
}

site/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ npm i
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ npm run start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ npm run build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true npm run deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> npm run deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

site/docs/concepts/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Concepts",
3+
"position": 6,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Concepts to OpenVINO GenAI."
7+
}
8+
}

site/docs/concepts/beam-search.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Beam Search
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Lora Optimization
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Optimization techniques",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Optimization techniques to OpenVINO GenAI."
7+
}
8+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Continuous Batching
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# KVCache Token Eviction Algorithm
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Prefix Caching
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Speculative Decoding
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Stateful Models vs Stateless Models
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Getting Started",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Getting started guide for OpenVINO GenAI"
7+
}
8+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Introduction
4+
---
5+
6+
# Introduction to OpenVINO GenAI
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Quick Start Guide
+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "How-to guides",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "How-to guides to OpenVINO GenAI."
7+
}
8+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Build Chat Agent
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Convert HuggingFace Model to OpenVINO
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# Image Generation

site/docs/how-to-guides/llm.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# LLM
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Loading Multiple LoRA Adapters
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Download a Model from HuggingFace
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Convert ModelScope Model to OpenVINO
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 9
3+
---
4+
5+
# Speech to Text

site/docs/how-to-guides/vlm.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 7
3+
---
4+
5+
# VLM

site/docs/samples/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Samples",
3+
"position": 5,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Samples to OpenVINO GenAI."
7+
}
8+
}

site/docs/samples/sample.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Sample
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Convert and Optimize Model
2+
3+
<Tabs groupId="model-source">
4+
<TabItem label="From Hugging Face" value="huggingface">
5+
Use `optimum-intel` package to convert and optimize models:
6+
```bash
7+
pip install optimum-intel[openvino]
8+
```
9+
10+
Download and convert a model to the OpenVINO IR format:
11+
<Tabs groupId="export-precision">
12+
<TabItem label="Compress weights to the int4 precision" value="int4">
13+
```bash
14+
optimum-cli export openvino --model meta-llama/Llama-2-7b-chat-hf --weight-format int4 ov_llama_2_7b_int4 --trust-remote-code
15+
```
16+
</TabItem>
17+
<TabItem label="Keep full model precision" value="fp16">
18+
```bash
19+
optimum-cli export openvino --model meta-llama/Llama-2-7b-chat-hf --weight-format fp16 ov_llama_2_7b_fp16 --trust-remote-code
20+
```
21+
</TabItem>
22+
</Tabs>
23+
24+
:::info
25+
26+
Check a full list of conversion options [here](https://huggingface.co/docs/optimum/en/intel/openvino/export).
27+
28+
:::
29+
30+
:::tip
31+
32+
You can also use [pre-converted LLMs](https://huggingface.co/collections/OpenVINO/llm-6687aaa2abca3bbcec71a9bd).
33+
34+
:::
35+
</TabItem>
36+
<TabItem label="From Model Scope" value="modelscope">
37+
Use `modelscope` and `optimum-intel` packages to convert and optimize models:
38+
```bash
39+
pip install modelscope optimum-intel[openvino]
40+
```
41+
42+
Download the required model to a local folder:
43+
```bash
44+
modelscope download --model 'Qwen/Qwen2-7b' --local_dir model_path
45+
```
46+
47+
:::tip
48+
49+
Convert the model and compress weights:
50+
51+
<Tabs groupId="export-precision">
52+
<TabItem label="INT4" value="int4">
53+
```bash
54+
optimum-cli export openvino -m model_path --weight-format int4 ov_qwen2_7b_int4 --task text-generation-with-past
55+
```
56+
</TabItem>
57+
<TabItem label="INT8" value="int8">
58+
```bash
59+
optimum-cli export openvino -m model_path --weight-format int8 ov_qwen2_7b_int8 --task text-generation-with-past
60+
```
61+
</TabItem>
62+
<TabItem label="FP16" value="fp16">
63+
```bash
64+
optimum-cli export openvino -m model_path --weight-format fp16 ov_qwen2_7b_fp16 --task text-generation-with-past
65+
```
66+
</TabItem>
67+
</Tabs>
68+
69+
:::
70+
</TabItem>
71+
</Tabs>

0 commit comments

Comments
 (0)