diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 05da0c6c..f8b6b949 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -27,3 +27,14 @@ If you have installed Metaflow previously, you can upgrade to the latest version ```bash pip install --upgrade metaflow ``` +:::tip + +Windows Installation & Local UI Troubleshooting +If you are installing Metaflow on Windows, you may encounter environment-specific hurdles. Follow these steps for a smoother setup: + +1. **WSL2 Recommended**: For the best experience, we recommend using Windows Subsystem for Linux (WSL). If you encounter permission errors with `pip install`, ensure your WSL distribution is up to date. +2. **Local UI Setup**: To verify your installation and view your flows locally: + - Run a basic flow: `python helloworld.py run` + - Start the local metadata service: `metaflow service start` + - Access the UI at `http://localhost:8080`. +:::