From 3202e1fa16bf39b5f1cca284d00e4b745de6522d Mon Sep 17 00:00:00 2001 From: Kio-1 Date: Fri, 20 Mar 2026 20:17:31 +0530 Subject: [PATCH 1/4] Enhance Windows installation instructions in install.md Added troubleshooting tips for Windows installation and local UI setup. --- docs/getting-started/install.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 05da0c6c..d709e247 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -27,3 +27,13 @@ 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 (such as on an Asus Zenbook or similar laptop), 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 (WSL2). 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`. +3. **Environment Persistence**: If `metaflow` commands are not recognized after installation, ensure the Python Scripts folder (e.g., `...\Python312\Scripts`) is added to your Windows System PATH. +::: From 328933e25ba4e6ce685509756cb29ef2ad35de47 Mon Sep 17 00:00:00 2001 From: Kio-1 Date: Fri, 20 Mar 2026 20:20:12 +0530 Subject: [PATCH 2/4] Update install.md --- docs/getting-started/install.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index d709e247..aba9276a 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -27,7 +27,8 @@ If you have installed Metaflow previously, you can upgrade to the latest version ```bash pip install --upgrade metaflow ``` -:::tip Windows Installation & Local UI Troubleshooting +::: +tip Windows Installation & Local UI Troubleshooting If you are installing Metaflow on Windows (such as on an Asus Zenbook or similar laptop), 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 (WSL2). If you encounter permission errors with `pip install`, ensure your WSL distribution is up to date. From 25e17181701cca65a225e03232a970a992fd987e Mon Sep 17 00:00:00 2001 From: Kio-1 Date: Fri, 20 Mar 2026 20:21:08 +0530 Subject: [PATCH 3/4] Enhance Windows installation guidance in install.md Added troubleshooting tips for Windows installation and local UI setup. --- docs/getting-started/install.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index aba9276a..0a9f29ae 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -27,8 +27,9 @@ If you have installed Metaflow previously, you can upgrade to the latest version ```bash pip install --upgrade metaflow ``` -::: -tip Windows Installation & Local UI Troubleshooting +:::tip + +Windows Installation & Local UI Troubleshooting If you are installing Metaflow on Windows (such as on an Asus Zenbook or similar laptop), 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 (WSL2). If you encounter permission errors with `pip install`, ensure your WSL distribution is up to date. From 82a2a7bcf6ed9eb2f8dc5f0fe2307856fc433862 Mon Sep 17 00:00:00 2001 From: Kio-1 Date: Fri, 20 Mar 2026 20:31:15 +0530 Subject: [PATCH 4/4] Refine Windows installation instructions in install.md Corrected wording for Windows installation instructions and removed redundant phrases. --- docs/getting-started/install.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 0a9f29ae..f8b6b949 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -30,12 +30,11 @@ pip install --upgrade metaflow :::tip Windows Installation & Local UI Troubleshooting -If you are installing Metaflow on Windows (such as on an Asus Zenbook or similar laptop), you may encounter environment-specific hurdles. Follow these steps for a smoother setup: +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 (WSL2). If you encounter permission errors with `pip install`, ensure your WSL distribution is up to date. +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`. -3. **Environment Persistence**: If `metaflow` commands are not recognized after installation, ensure the Python Scripts folder (e.g., `...\Python312\Scripts`) is added to your Windows System PATH. :::