Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add initial docs pages version #1765

Merged
merged 65 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from 59 commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
5ba73fc
Add initial docusaurus site
yatarkan Feb 13, 2025
71a1420
Add workflow for deploying GH Pages
yatarkan Feb 13, 2025
1b001d7
Downgrade react version
yatarkan Feb 13, 2025
062620e
Enable lfs in actions checkout for deploy page workflow
yatarkan Feb 13, 2025
7b7c210
Fix search bar styles
yatarkan Feb 14, 2025
f97c65a
Fix wording
yatarkan Feb 17, 2025
bfb871e
Fix OV logo alignment
yatarkan Feb 17, 2025
cb50e35
Update section styles
yatarkan Feb 17, 2025
353bceb
Fix installation styles
yatarkan Feb 17, 2025
358cb39
Remove font
yatarkan Feb 17, 2025
6c967e4
Move global styles to separate files
yatarkan Feb 17, 2025
80f79be
Add WIP status to header
yatarkan Feb 17, 2025
e637ea3
Add navbar title, fix styles
yatarkan Feb 18, 2025
bc530c6
Replace image code examples with code blocks in homepage features
yatarkan Feb 18, 2025
29f2ac7
Replace code example component with standard code block
yatarkan Feb 18, 2025
d47d992
Remove redundant dependencies
yatarkan Feb 18, 2025
52fa89c
Fix global section element styles
yatarkan Feb 18, 2025
0687267
Restructure llm use case files
yatarkan Feb 18, 2025
d01c269
Rename section to match file structure
yatarkan Feb 18, 2025
5016f68
Remove unused component
yatarkan Feb 18, 2025
35c1d92
Add new language tabs component
yatarkan Feb 18, 2025
99b9c27
Expose mdx components and language tabs
yatarkan Feb 18, 2025
5fd2b80
Remove old language tabs component, reuse new one
yatarkan Feb 18, 2025
c5c7257
Export theme tabs
yatarkan Feb 18, 2025
35fe676
Reuse language tabs in llm pipeline mdx sections
yatarkan Feb 18, 2025
a4fc781
Fix code block styles in section on home page
yatarkan Feb 18, 2025
5a6dd65
Enable eslint
yatarkan Feb 19, 2025
c755e0a
Fix lint
yatarkan Feb 19, 2025
54a0d76
Reformat with prettier
yatarkan Feb 19, 2025
6ff7544
Update org name
yatarkan Feb 19, 2025
67b3873
Format mdx files
yatarkan Feb 19, 2025
420158c
Add prettier ignore
yatarkan Feb 19, 2025
fae8616
Fix method name in streamer example
yatarkan Feb 20, 2025
6c12ce2
Remove redundant prop
yatarkan Feb 20, 2025
33b7ebb
Remove peer dependencies
yatarkan Feb 20, 2025
8a6240a
Remove usage of clsx dep
yatarkan Feb 20, 2025
b58bfbf
Remove duplicated section column
yatarkan Feb 20, 2025
7268888
Replace footer link to ov docs
yatarkan Feb 20, 2025
8023a39
Remove reference section
yatarkan Feb 20, 2025
0953cb7
Fix indent
yatarkan Feb 20, 2025
60f6115
Fix returning enum from streamer
yatarkan Feb 20, 2025
f337fa3
Fix links
yatarkan Feb 20, 2025
a393692
Move alternating flags closer to command beginning
yatarkan Feb 20, 2025
bcedf7a
Reused text generation code examples
yatarkan Feb 20, 2025
ff5f93b
Fix code example
yatarkan Feb 20, 2025
7e3d722
Add button component
yatarkan Feb 20, 2025
8c3f7f6
Add install buttons with links to selector tool
yatarkan Feb 20, 2025
60dd638
Remove text placeholders
yatarkan Feb 20, 2025
7230430
Fix menu caret styles
yatarkan Feb 21, 2025
a08ce5b
Remove overview category
yatarkan Feb 21, 2025
a48eb5f
Remove getting started pages
yatarkan Feb 21, 2025
2cf583d
Enable install external link in sidebar
yatarkan Feb 21, 2025
ebcc1c8
Configure autogenerated items to ignore categories
yatarkan Feb 21, 2025
1b5add4
Add quick start guide page
yatarkan Feb 21, 2025
dbd542c
Remove redundant installation options text
yatarkan Feb 21, 2025
21fc313
Fix button props
yatarkan Feb 21, 2025
bdee139
Fix primary colors for buttons
yatarkan Feb 21, 2025
74b1b2e
Fix link target
yatarkan Feb 21, 2025
02c0e57
Add get started button
yatarkan Feb 21, 2025
520b96e
Merge branch 'master' into docs-pages
andrei-kochin Feb 25, 2025
42cbfbe
Change home page use cases layout
yatarkan Mar 3, 2025
fe82dac
Merge branch 'master' into docs-pages
yatarkan Mar 3, 2025
c862b80
Fix GH pages ubuntu runner
yatarkan Mar 5, 2025
00b4363
Merge branch 'master' into docs-pages
yatarkan Mar 5, 2025
0849b03
Merge branch 'master' into docs-pages
yatarkan Mar 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/deploy_gh_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Deploy Docs to GitHub Pages

on:
workflow_dispatch:

concurrency:
group: 'pages'
cancel-in-progress: true

permissions:
contents: read

jobs:
build_assets:
runs-on: ubuntu-20.04
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
with:
lfs: true

- name: Setup Node.js
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: 20

- name: Install Node.js dependencies
working-directory: ./site
shell: bash
run: npm ci

- name: Build static for GitHub Pages
working-directory: ./site
shell: bash
run: npm run build

- name: Upload pages artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
with:
path: ./site/build

deploy_github_pages:
runs-on: ubuntu-20.04
needs: build_assets
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
16 changes: 16 additions & 0 deletions site/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# http://editorconfig.org

root = false

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
max_line_length = 100
trim_trailing_whitespace = true

[*.md]
insert_final_newline = true
trim_trailing_whitespace = false
20 changes: 20 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
12 changes: 12 additions & 0 deletions site/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
dist
node_modules
.yarn
build
coverage
.docusaurus
.idea

.svg
*.svg

*.mdx
10 changes: 10 additions & 0 deletions site/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"printWidth": 100,
"trailingComma": "es5",
"useTabs": false,
"tabWidth": 2,
"semi": true,
"bracketSpacing": true,
"singleQuote": true,
"arrowParens": "always"
}
41 changes: 41 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ npm i
```

### Local Development

```
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true npm run deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> npm run deploy
```

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.
8 changes: 8 additions & 0 deletions site/docs/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Concepts",
"position": 6,
"link": {
"type": "generated-index",
"description": "Concepts to OpenVINO GenAI."
}
}
5 changes: 5 additions & 0 deletions site/docs/concepts/beam-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Beam Search
5 changes: 5 additions & 0 deletions site/docs/concepts/lora-optimization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Lora Optimization
8 changes: 8 additions & 0 deletions site/docs/concepts/optimization-techniques/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Optimization techniques",
"position": 4,
"link": {
"type": "generated-index",
"description": "Optimization techniques to OpenVINO GenAI."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Continuous Batching
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# KVCache Token Eviction Algorithm
5 changes: 5 additions & 0 deletions site/docs/concepts/optimization-techniques/prefix-caching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 4
---

# Prefix Caching
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Speculative Decoding
5 changes: 5 additions & 0 deletions site/docs/concepts/stateful-vs-stateless-models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Stateful Models vs Stateless Models
8 changes: 8 additions & 0 deletions site/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Getting Started",
"position": 1,
"link": {
"type": "generated-index",
"description": "Getting started guide for OpenVINO GenAI"
}
}
6 changes: 6 additions & 0 deletions site/docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
sidebar_label: Introduction
---

# Introduction to OpenVINO GenAI
5 changes: 5 additions & 0 deletions site/docs/getting-started/quick-start-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Quick Start Guide
8 changes: 8 additions & 0 deletions site/docs/how-to-guides/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "How-to guides",
"position": 4,
"link": {
"type": "generated-index",
"description": "How-to guides to OpenVINO GenAI."
}
}
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/build-chat-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 6
---

# Build Chat Agent
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/hugging-face-to-openvino.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Convert HuggingFace Model to OpenVINO
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/image-generation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 8
---

# Image Generation
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/llm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 5
---

# LLM
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/lora-adapters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 4
---

# Loading Multiple LoRA Adapters
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/model-download-hugging-face.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Download a Model from HuggingFace
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/model-scope-to-openvino.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 3
---

# Convert ModelScope Model to OpenVINO
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/speech-to-text.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 9
---

# Speech to Text
5 changes: 5 additions & 0 deletions site/docs/how-to-guides/vlm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 7
---

# VLM
8 changes: 8 additions & 0 deletions site/docs/samples/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Samples",
"position": 5,
"link": {
"type": "generated-index",
"description": "Samples to OpenVINO GenAI."
}
}
5 changes: 5 additions & 0 deletions site/docs/samples/sample.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Sample
71 changes: 71 additions & 0 deletions site/docs/use-cases/1-LLM-pipeline/_sections/_convert_model.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
## Convert and Optimize Model

<Tabs groupId="model-source">
<TabItem label="From Hugging Face" value="huggingface">
Use `optimum-intel` package to convert and optimize models:
```bash
pip install optimum-intel[openvino]
```

Download and convert a model to the OpenVINO IR format:
<Tabs groupId="export-precision">
<TabItem label="Compress weights to the int4 precision" value="int4">
```bash
optimum-cli export openvino --model meta-llama/Llama-2-7b-chat-hf --weight-format int4 ov_llama_2_7b_int4 --trust-remote-code
```
</TabItem>
<TabItem label="Keep full model precision" value="fp16">
```bash
optimum-cli export openvino --model meta-llama/Llama-2-7b-chat-hf --weight-format fp16 ov_llama_2_7b_fp16 --trust-remote-code
```
</TabItem>
</Tabs>

:::info

Check a full list of conversion options [here](https://huggingface.co/docs/optimum/en/intel/openvino/export).

:::

:::tip

You can also use [pre-converted LLMs](https://huggingface.co/collections/OpenVINO/llm-6687aaa2abca3bbcec71a9bd).

:::
</TabItem>
<TabItem label="From Model Scope" value="modelscope">
Use `modelscope` and `optimum-intel` packages to convert and optimize models:
```bash
pip install modelscope optimum-intel[openvino]
```

Download the required model to a local folder:
```bash
modelscope download --model 'Qwen/Qwen2-7b' --local_dir model_path
```

:::tip

Convert the model and compress weights:

<Tabs groupId="export-precision">
<TabItem label="INT4" value="int4">
```bash
optimum-cli export openvino -m model_path --weight-format int4 ov_qwen2_7b_int4 --task text-generation-with-past
```
</TabItem>
<TabItem label="INT8" value="int8">
```bash
optimum-cli export openvino -m model_path --weight-format int8 ov_qwen2_7b_int8 --task text-generation-with-past
```
</TabItem>
<TabItem label="FP16" value="fp16">
```bash
optimum-cli export openvino -m model_path --weight-format fp16 ov_qwen2_7b_fp16 --task text-generation-with-past
```
</TabItem>
</Tabs>

:::
</TabItem>
</Tabs>
Loading
Loading