Skip to content

Commit 3a40326

Browse files
rasapalarasapala
authored
Windows docs update (#2856)
* Windows docs update
1 parent 4cc1aa1 commit 3a40326

File tree

4 files changed

+61
-23
lines changed

4 files changed

+61
-23
lines changed

‎docs/build_from_source.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,3 +173,9 @@ dist/ubuntu22
173173

174174

175175
Read more detailed usage in [developer guide](https://github.com/openvinotoolkit/model_server/blob/releases/2024/5/docs/developer_guide.md).
176+
177+
## Building ovms.exe on Windows
178+
179+
[Developer Guide for Windows](windows_developer_guide.md) document describes experimental/alpha windows deployment for ovms.exe binary.
180+
Follow the instructions to start the ovms server as a standalone binary on a Windows 11 system.
181+

‎docs/deploying_server.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,9 @@ For operators mentioned in 2. and 3. see the [description of the deployment proc
273273
- [Using Cloud Storage](using_cloud_storage.md)
274274
- [Troubleshooting](troubleshooting.md)
275275
- [Model server parameters](parameters.md)
276+
277+
## Deploying ovms.exe on Windows
278+
279+
Once you have built the ovms.exe following the [Developer Guide for Windows](windows_developer_guide.md)
280+
Follow the experimental/alpha windows deployment instructions to start the ovms server as a standalone binary on a Windows 11 system.
281+
[Deployment Guide for Windows](windows_binary_guide.md)

‎docs/windows_binary_guide.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1-
# OpenVINO™ Model Server Developer Guide for Windows
2-
## No MEDIAPIPE support
3-
## No PYTHON NODES support
4-
## No REST API support
1+
# OpenVINO™ Model Server Deployment Guide for Windows 11 (Experimental/Alpha)
2+
This document describes experimental/alpha windows deployment for ovms.exe binary.
3+
Follow the instructions once you have compiled ovms.exe and you want to deploy the binary on a Windows 11 system.
4+
[Developer Guide for Windows](windows_developer_guide.md)
5+
6+
OpenVINO™ Model Server is in experimental/alpha stage of windows enabling with limited functionality and quality.
7+
It is recommended to use the top of main repository branch for more feature enabled code and better software quality for windows.
8+
9+
## List of enabled features:
10+
### Limited model server basic functionality besides disabled features
11+
### GRPC API
12+
### Mediapipe graphs execution
13+
### Serving single models in all formats
14+
15+
## List of disabled features:
16+
### Ovms feature parity with Linux implementation
17+
### LLM support
18+
### PYTHON NODES support
19+
### REST API support
20+
### Custom nodes support
21+
### Cloud storage support
22+
### Model cache support
23+
### DAG pipelines
524

625
# Install prerequisites
726
```
827
md c:\git
928
md c:\opt
1029
```
1130

12-
## VISAUL
13-
Visual Studio 2022 with C++ - https://visualstudio.microsoft.com/downloads/
31+
## VISUAL STUDIO
32+
Visual Studio 2019 with C++ - https://visualstudio.microsoft.com/downloads/
1433

1534
## PYTHON: https://www.python.org/ftp/python/3.9.0/python-3.9.0-amd64.exe in C:\opt\Python39
1635
Python3. (Python 3.11.9 is tested)

‎docs/windows_developer_guide.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
1-
# OpenVINO™ Model Server Developer Guide for Windows
1+
# OpenVINO™ Model Server Developer Guide for Windows (Experimental/Alpha)
2+
This document describes experimental/alpha windows development and compilation guide for ovms.exe binary.
3+
4+
OpenVINO™ Model Server is in experimental/alpha stage of windows enabling with limited functionality and quality.
5+
It is recommended to use the top of main repository branch for more feature enabled code and better software quality for windows.
6+
7+
## List of enabled features:
8+
### Limited model server basic functionality besides disabled features
9+
### GRPC API
10+
### Mediapipe graphs execution
11+
### Serving single models in all formats
12+
13+
## List of disabled features:
14+
### Ovms feature parity with Linux implementation
15+
### LLM support
16+
### PYTHON NODES support
17+
### REST API support
18+
### Custom nodes support
19+
### Cloud storage support
20+
### Model cache support
21+
### DAG pipelines
222

323
# Install prerequisites
424
```
525
md c:\git
626
md c:\opt
727
```
828

9-
## VISAUL
10-
Visual Studio 2022 with C++ - https://visualstudio.microsoft.com/downloads/
29+
## VISUAL STUDIO
30+
Visual Studio 2019 with C++ - https://visualstudio.microsoft.com/downloads/
1131

1232
## PYTHON: https://www.python.org/ftp/python/3.9.0/python-3.9.0-amd64.exe in C:\opt\Python39
1333
Python3. (Python 3.11.9 is tested)
@@ -53,7 +73,7 @@ https://github.com/opencv/opencv/releases/download/4.10.0/opencv-4.10.0-windows.
5373
https://eternallybored.org/misc/wget/1.21.4/64/wget.exe download to c:\opt
5474
Add c:\opt to system env PATH
5575

56-
## Run Developer Command Prompt for VS 2022
76+
## Run Developer Command Prompt for VS 2019
5777
## Enable Developer mode on in windows system settings
5878

5979
#### Boring SSL - not needed until md5 hash is needed.
@@ -62,19 +82,6 @@ Clone in in c:\opt\
6282
git clone https://github.com/firebase/boringSSL-SwiftPM.git
6383
```
6484

65-
## Libevent - ovms link phase
66-
```git clone https://github.com/libevent/libevent
67-
git co release-2.1.12-stable
68-
md build && cd build
69-
C:\git\libevent\build>cmake -G "Visual Studio 17 2022" -DEVENT__DISABLE_OPENSSL=1 -DEVENT_LIBRARY_SHARED=0 ..
70-
cmake --build . --config Release
71-
md c:\opt\libevent
72-
xcopy lib\Release\* c:\opt\libevent\lib\
73-
xcopy /s /e include\event2\* c:\opt\libevent\include\event2\
74-
cd ..
75-
xcopy /s /e include\ c:\opt\libevent\include\
76-
```
77-
7885
# Opencl headers
7986
```
8087
cd c:\opt

0 commit comments

Comments
 (0)