Updated Docs for Windows Compatibility

UtkarshTheDev · UtkarshTheDev · commit e0e76d78edec · 2025-04-23T23:13:23.000+05:30
diff --git a/README.md b/README.md
@@ -44,8 +44,30 @@ graph TD
 
 ## 📦 Installation & Setup
 
-### 1. Install Required Packages
+### Windows Setup
+1. **Install Required Build Tools**
+   - Install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
+     - Select "Desktop development with C++"
+   - Install [CMake](https://cmake.org/download/)
+     - Add to PATH during installation
+
+2. **Install Packages**
+   ```powershell
+   pip install locallab locallab-client
+   ```
+
+3. **Verify PATH**
+   - If `locallab` command isn't found, add Python Scripts to PATH:
+     ```powershell
+     # Find Python location
+     where python
+     # Add Scripts folder to PATH (e.g., C:\Users\YOU\AppData\Local\Programs\Python\Python311\Scripts\)
+     ```
+   - Or use: `python -m locallab start`
+
+> 🔍 Having issues? See our [Windows Troubleshooting Guide](./docs/guides/troubleshooting.md#windows-specific-issues)
 
+### Linux/Mac Setup
 ```bash
 # Install both server and client packages
 pip install locallab locallab-client
diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md
@@ -10,15 +10,48 @@ This guide will help you start using LocalLab, whether you're new to AI or an ex
 - GPU optional but recommended
 - Internet connection for downloading models
 
+#### Additional Requirements for Windows
+- Microsoft C++ Build Tools (for some dependencies)
+- CMake (for model compilation)
+- Python added to PATH
+
 ### For Google Colab
 - Just a Google account!
 - Internet connection
 
 ## 🚀 Step-by-Step Setup
 
-### Step 1: Install Required Packages
+### Windows Setup
+
+1. **Install Required Build Tools**
+   ```powershell
+   # First, install Microsoft C++ Build Tools
+   # Download from: https://visualstudio.microsoft.com/visual-cpp-build-tools/
+   # Select "Desktop development with C++"
+
+   # Then install CMake
+   # Download from: https://cmake.org/download/
+   # Make sure to add to PATH during installation
+   ```
+
+2. **Install Python Packages**
+   ```powershell
+   # Install the server package
+   pip install locallab
+
+   # Install the client package
+   pip install locallab-client
+   ```
+
+3. **Add to PATH (if needed)**
+   - Find your Python Scripts directory:
+     ```powershell
+     where python
+     ```
+   - Add the Scripts folder to PATH (e.g., `C:\Users\YOU\AppData\Local\Programs\Python\Python311\Scripts\`)
+   - Restart your terminal
 
-First, you need to install both the server and client packages:
+### Linux/Mac Setup
 
 ```bash
 # Install the server package
@@ -28,25 +61,64 @@ pip install locallab
 pip install locallab-client
 ```
 
-### Step 2: Start the Server
+### Configure LocalLab (Required First Step)
 
-You have two options:
+Before starting the server, you should configure LocalLab. You have two options:
 
-#### Option A: Using Command Line (Recommended for Beginners)
+#### Option A: Using CLI (Recommended)
 ```bash
-# Start with interactive setup
+# Run the configuration wizard
+locallab config
+```
+
+This will help you configure:
+- Model selection
+- Memory optimizations
+- GPU settings
+- System resources
+
+#### Option B: Using Python Code
+```python
+from locallab.cli.config import set_config_value, save_config
+from locallab.cli.interactive import prompt_for_config
+
+# Method 1: Interactive Configuration
+config = prompt_for_config()
+save_config(config)
+
+# Method 2: Direct Configuration
+set_config_value("model_id", "microsoft/phi-2")
+set_config_value("enable_quantization", True)
+set_config_value("quantization_type", "int8")
+set_config_value("enable_attention_slicing", True)
+```
+
+### Start the Server
+
+After configuring, you can start the server:
+
+#### Option A: Using Command Line
+```bash
+# Start with saved configuration
 locallab start
+
+# Or start with specific options
+locallab start --model microsoft/phi-2 --quantize --quantize-type int8
 ```
-This will:
-- Guide you through setup
-- Help choose a model
-- Configure optimizations
-- Start the server
 
 #### Option B: Using Python Code
 ```python
 from locallab import start_server
+
+# Start with saved configuration
 start_server()
+
+# Or start with specific options
+start_server(
+    model_id="microsoft/phi-2",
+    enable_quantization=True,
+    quantization_type="int8"
+)
 ```
 
 ### Step 3: Connect with a Client
diff --git a/docs/guides/troubleshooting.md b/docs/guides/troubleshooting.md
@@ -2,6 +2,50 @@
 
 ## 🔍 Common Issues for Beginners
 
+### Windows-Specific Issues
+
+#### 'locallab' Command Not Found
+**Problem:** After installation, the `locallab` command isn't recognized
+```
+'locallab' is not recognized as an internal or external command
+```
+**Solution:**
+1. Check if Python's Scripts directory is in PATH:
+   ```cmd
+   where python
+   ```
+2. Add Python Scripts to PATH:
+   - Find your Python install location (e.g., `C:\Users\YOU\AppData\Local\Programs\Python\Python311\`)
+   - Add `Scripts` folder to PATH: `C:\Users\YOU\AppData\Local\Programs\Python\Python311\Scripts\`
+   - Restart your terminal
+
+Alternative: Use the module directly:
+```cmd
+python -m locallab start
+```
+
+#### Compiler/Build Tools Missing
+**Problem:** Installation fails with errors about missing compiler or CMake
+```
+error: Microsoft Visual C++ 14.0 or greater is required
+```
+or
+```
+'nmake' is not recognized
+CMAKE_C_COMPILER not set
+```
+**Solution:**
+1. Install Build Tools:
+   - Download [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
+   - During installation, select "Desktop development with C++"
+2. Install CMake:
+   - Download from [cmake.org](https://cmake.org/download/)
+   - Add to PATH during installation
+3. Restart your terminal and try installation again:
+   ```cmd
+   pip install locallab --no-cache-dir
+   ```
+
 ### Installation Issues
 
 **Problem:** `pip install` fails
diff --git a/setup.py b/setup.py
@@ -1,41 +1,55 @@
 from setuptools import setup, find_packages
+import platform
 
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
-setup(
-    name="locallab",
-    version="0.5.1",
-    packages=find_packages(include=["locallab", "locallab.*"]),
-    install_requires=[
-        "fastapi>=0.95.0,<1.0.0",
-        "uvicorn>=0.21.1,<1.0.0",
-        "pydantic>=2.0.0,<3.0.0",
-        "python-dotenv>=0.21.0,<1.0.0",
-        "python-multipart>=0.0.5",
-        "dataclasses-json>=0.5.7,<1.0.0",
-        "torch>=2.0.0,<3.0.0",
-        "transformers>=4.28.1,<5.0.0",
-        "accelerate>=0.18.0,<1.0.0",
+# Base requirements
+install_requires = [
+    "fastapi>=0.95.0,<1.0.0",
+    "uvicorn>=0.21.1,<1.0.0",
+    "pydantic>=2.0.0,<3.0.0",
+    "python-dotenv>=0.21.0,<1.0.0",
+    "python-multipart>=0.0.5",
+    "dataclasses-json>=0.5.7,<1.0.0",
+    "torch>=2.0.0,<3.0.0",
+    "transformers>=4.28.1,<5.0.0",
+    "accelerate>=0.18.0,<1.0.0",
+    "click>=8.1.3,<9.0.0",
+    "rich>=13.3.4,<14.0.0",
+    "pyngrok>=6.0.0,<7.0.0",
+    "requests>=2.28.2,<3.0.0",
+    "httpx>=0.24.0",
+    "colorama>=0.4.4",
+    "websockets>=10.0",
+    "psutil>=5.8.0",
+    "nest-asyncio>=1.5.1",
+    "fastapi-cache2>=0.2.1",
+    "huggingface_hub>=0.16.0",
+    "typing_extensions>=4.0.0",
+    "questionary>=1.10.0",
+]
+
+# Platform-specific dependencies
+if platform.system() == "Windows":
+    install_requires.extend([
+        "bitsandbytes-windows>=0.37.2",
+        "llama-cpp-python>=0.1.77",
+    ])
+else:
+    install_requires.extend([
         "bitsandbytes>=0.38.0,<1.0.0",
         "llama-cpp-python>=0.1.74,<1.0.0",
-        "click>=8.1.3,<9.0.0",
-        "rich>=13.3.4,<14.0.0",
-        "pyngrok>=6.0.0,<7.0.0",
-        "requests>=2.28.2,<3.0.0",
         "netifaces>=0.11.0",
-        "httpx>=0.24.0",
-        "colorama>=0.4.4",
-        "websockets>=10.0",
-        "psutil>=5.8.0",
-        "nest-asyncio>=1.5.1",
-        "fastapi-cache2>=0.2.1",
         "nvidia-ml-py3>=7.352.0",
-        "huggingface_hub>=0.16.0",
         "pynvml>=11.0.0",
-        "typing_extensions>=4.0.0",
-        "questionary>=1.10.0",
-    ],
+    ])
+
+setup(
+    name="locallab",
+    version="0.5.1",
+    packages=find_packages(include=["locallab", "locallab.*"]),
+    install_requires=install_requires,
     extras_require={
         "dev": [
             "pytest>=7.0.0",
@@ -57,6 +71,9 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: MacOS",
     ],
     python_requires=">=3.9",
     entry_points={
