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.

Sign up for GitHub

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

Update links in documentation, fix unzip command on Windows #652

Closed
wants to merge 7 commits into from
Closed

Update links in documentation, fix unzip command on Windows #652

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dccb20b
Update archive links, fix unzip command on Windows
helena-intel Jul 19, 2024
22a7ad7
Update src/README.md
helena-intel Jul 19, 2024
4895da9
Update samples/requirements.txt
helena-intel Jul 19, 2024
63ce389
Update src/README.md
helena-intel Jul 19, 2024
04497b4
Update src/README.md
helena-intel Jul 19, 2024
da5c7fb
Merge branch 'master' into helena/readme-update
helena-intel Jul 23, 2024
5c1f320
Add NSIS requirement
helena-intel Jul 23, 2024
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
2 changes: 1 addition & 1 deletion samples/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
--extra-index-url https://download.pytorch.org/whl/cpu
optimum[openvino]==1.20.0
optimum[openvino]>=1.20.0
helena-intel marked this conversation as resolved.
Show resolved Hide resolved
einops==0.8.0 # For Qwen
transformers_stream_generator==0.0.5 # For Qwen
27 changes: 14 additions & 13 deletions src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,25 @@ It hides the complexity of the generation process and minimizes the amount of co
The OpenVINO™ GenAI flavor is available for installation via Archive and PyPI distributions.
To install OpenVINO™ GenAI, refer to the [Install Guide](https://docs.openvino.ai/2024/get-started/install-openvino.html).

To build OpenVINO™ GenAI library from source, refer to the [Build Instructions](https://github.com/openvinotoolkit/openvino.genai/tree/releases/2024/2/src/docs/BUILD.md).
To build OpenVINO™ GenAI library from source, refer to the [Build Instructions](https://github.com/openvinotoolkit/openvino.genai/blob/master/src/docs/BUILD.md)
helena-intel marked this conversation as resolved.
Show resolved Hide resolved

## Usage

### Prerequisites

1. Installed OpenVINO™ GenAI

> If OpenVINO GenAI is installed via archive distribution or built from source, you will need to install additional python dependencies (e.g. `optimum-cli` for simplified model downloading and exporting, it's not required to install [./samples/requirements.txt](./samples/requirements.txt) for deployment if the model has already been exported):
>
> ```sh
> # (Optional) Clone OpenVINO GenAI repository if it does not exist
> git clone --recursive https://github.com/openvinotoolkit/openvino.genai.git
> cd openvino.genai
> # Install python dependencies
> python -m pip install ./thirdparty/openvino_tokenizers/[transformers] --pre --extra-index-url https://storage.openvinotoolkit.org/simple/wheels/nightly
> python -m pip install --upgrade-strategy eager -r ./samples/requirements.txt
> ```
> To use OpenVINO GenAI with models that are already in OpenVINO format, no additional dependencies are needed. To
helena-intel marked this conversation as resolved.
Show resolved Hide resolved
> convert models with optimum-cli and to run the examples, install the dependencies in
> [./samples/requirements.txt](./samples/requirements.txt):
```sh
# (Optional) Clone OpenVINO GenAI repository if it does not exist
git clone --recursive https://github.com/openvinotoolkit/openvino.genai.git
cd openvino.genai
# Install python dependencies
python -m pip install ./thirdparty/openvino_tokenizers/[transformers] --pre --extra-index-url https://storage.openvinotoolkit.org/simple/wheels/nightly
python -m pip install --upgrade-strategy eager -r ./samples/requirements.txt
```

2. A model in OpenVINO IR format

Expand Down Expand Up @@ -198,8 +199,8 @@ int main(int argc, char* argv[]) {

## How It Works

For information on how OpenVINO™ GenAI works, refer to the [How It Works Section](https://github.com/openvinotoolkit/openvino.genai/tree/releases/2024/2/src/docs/HOW_IT_WORKS.md).
For information on how OpenVINO™ GenAI works, refer to the [How It Works Section](https://github.com/openvinotoolkit/openvino.genai/blob/master/src/docs/BUILD.md).
helena-intel marked this conversation as resolved.
Show resolved Hide resolved

## Supported Models

For a list of supported models, refer to the [Supported Models Section](https://github.com/openvinotoolkit/openvino.genai/tree/releases/2024/2/src/docs/SUPPORTED_MODELS.md).
For a list of supported models, refer to the [Supported Models Section](https://github.com/openvinotoolkit/openvino.genai/blob/master/src/docs/SUPPORTED_MODELS.md).
20 changes: 13 additions & 7 deletions src/docs/BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@
git clone --recursive https://github.com/openvinotoolkit/openvino.genai.git
cd openvino.genai
```
2. Download OpenVINO archive and install dependencies:
2. Download and extract OpenVINO archive and install dependencies:

The OpenVINO archive link below is for Ubuntu 20 on x86. See [pre-release/2024.3.0rc1/linux/](https://storage.openvinotoolkit.org/repositories/openvino/packages/pre-release/2024.3.0rc1/linux/) for other Linux versions.

```sh
mkdir ./ov/
curl https://storage.openvinotoolkit.org/repositories/openvino/packages/nightly/2024.3.0-15805-6138d624dc1/l_openvino_toolkit_ubuntu20_2024.3.0.dev20240626_x86_64.tgz | tar --directory ./ov/ --strip-components 1 -xz
curl https://storage.openvinotoolkit.org/repositories/openvino/packages/pre-release/2024.3.0rc1/linux/l_openvino_toolkit_ubuntu20_2024.3.0.dev20240711_x86_64.tgz | tar --directory ./ov/ --strip-components 1 -xz
sudo ./ov/install_dependencies/install_openvino_dependencies.sh
```
3. Build the project:
Expand All @@ -45,12 +48,12 @@
git clone --recursive https://github.com/openvinotoolkit/openvino.genai.git
cd openvino.genai
```
2. Download OpenVINO archive and install dependencies:
2. Download and extract OpenVINO archive:
```sh
mkdir ./ov/
curl --output ov.zip https://storage.openvinotoolkit.org/repositories/openvino/packages/nightly/2024.3.0-15805-6138d624dc1/w_openvino_toolkit_windows_2024.3.0.dev20240626_x86_64.zip
unzip ov.zip
mklink /D ov w_openvino_toolkit_windows_2024.3.0.dev20240626_x86_64
curl --output ov.zip https://storage.openvinotoolkit.org/repositories/openvino/packages/pre-release/2024.3.0rc1/windows/w_openvino_toolkit_windows_2024.3.0.dev20240711_x86_64.zip
tar -xf ov.zip
mklink /D ov w_openvino_toolkit_windows_2024.3.0.dev20240711_x86_64
```
3. Build the project:
```sh
Expand Down Expand Up @@ -83,9 +86,12 @@
cd openvino.genai
```
2. Download OpenVINO archive and install dependencies:

The OpenVINO archive link below is for the x86 version of OpenVINO. For the ARM version, use [this link](https://storage.openvinotoolkit.org/repositories/openvino/packages/pre-release/2024.3.0rc1/macos/m_openvino_toolkit_macos_12_6_2024.3.0.dev20240711_arm64.tgz).

```sh
mkdir ./ov/
curl https://storage.openvinotoolkit.org/repositories/openvino/packages/nightly/2024.3.0-15805-6138d624dc1/l_openvino_toolkit_ubuntu20_2024.3.0.dev20240626_x86_64.tgz | tar --directory ./ov/ --strip-components 1 -xz
curl https://storage.openvinotoolkit.org/repositories/openvino/packages/pre-release/2024.3.0rc1/macos/m_openvino_toolkit_macos_12_6_2024.3.0.dev20240711_x86_64.tgz | tar --directory ./ov/ --strip-components 1 -xz
```
3. Build the project:
```sh
Expand Down
Loading