Skip to content

Commit cfe1b80

Browse files
stuqdognjooma
andauthored
Update README.md (viamrobotics#899)
Co-authored-by: Naveed Jooma <[email protected]>
1 parent 3448fa8 commit cfe1b80

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,19 @@ Currently, we have pre-built binaries for macOS (both Intel `x86_64` and Apple S
1818

1919
`pip install viam-sdk`
2020

21+
If you want to install on Windows, you can install from github directly with `pip`:
22+
23+
`pip install git+https://github.com/viamrobotics/viam-python-sdk.git`
24+
25+
Note that only direct gRPC connections are supported on Windows; you will need to [disable webrtc](https://python.viam.dev/autoapi/viam/rpc/dial/index.html#viam.rpc.dial.DialOptions.disable_webrtc) or else connection will fail. Full support (including webRTC) _does_ exist on WSL.
26+
2127
If you intend to use the [`MLModel` service](https://python.viam.dev/autoapi/viam/services/mlmodel/mlmodel/index.html#viam.services.mlmodel.mlmodel.MLModel), use the following command instead, which installs additional required dependencies:
2228

2329
`pip install 'viam-sdk[mlmodel]'`
2430

2531
You can also run this command on an existing Python SDK install to add support for the ML model service.
2632
See the [ML (machine learning) model service](https://docs.viam.com/data-ai/ai/deploy/) documentation for more information.
2733

28-
Windows is not supported. If you are using Windows, install `viam-sdk` in WSL. For other unsupported systems, read further on how to install from source.
29-
3034
### Upgrading
3135

3236
To upgrade, simply run the `pip install` command with the `-U` option:

0 commit comments

Comments
 (0)