Updated LocalLab v0.1.4 and Updated Docs

Author: UtkarshTheDev

CHANGELOG.md

@@ -2,13 +2,15 @@
 
 All notable changes for version updates.
 
-## [0.1.3] - 2024-02-27
+## [0.1.4] - 2024-02-25
 
 ### Changed
 
-- Updated GitHub Actions workflow to use the --no-cache-dir flag in pip install commands, which prevents disk space issues during dependency installation (e.g., for large packages like torch).
+- Improved logging across startup: the banner, model details, configuration, system resources, API documentation, quick start guide, and footer are now fully logged and printed.
+- Updated the start_server function to extend the health check timeout to 60 seconds in Google Colab (when using ngrok) and to set an environment variable to trigger the Colab branch in run_server_proc.
+- Modified startup_event to load the model in the background, ensuring that the server's /health endpoint becomes available in time and that logging output is complete.
 
-## [0.1.2] - 2024-02-25
+## [0.1.3] - 2024-02-25
 
 ### Changed
 
@@ -22,23 +24,28 @@ All notable changes for version updates.
 - Removed duplicate architecture diagrams from the root `README.md` to streamline documentation.
 - Minor improvements to logging and error handling.
 
+## [0.1.2] - 2024-02-25
+
+### Changed
+
+- Updated GitHub Actions workflow to install the Locallab package along with its runtime dependencies in CI.
+
+### Fixed
+
+- Fixed RuntimeError related to SemLock sharing in multiprocessing by clearing logger handlers in `run_server_proc`.
+- Updated Mermaid diagrams to wrap node labels in double quotes, improving compatibility with GitHub rendering.
+- Improved build status badge aesthetics in the README.
+
 ## [0.1.1] - 2024-02-25
 
 ### Fixed
 
 - Fixed RuntimeError related to SemLock sharing in multiprocessing by clearing logger handlers in `run_server_proc`.
-- Updated Mermaid diagrams in `README.md` and `docs/colab/README.md` to wrap node labels in double quotes, improving compatibility with GitHub rendering.
+- Updated Mermaid diagrams to wrap node labels in double quotes, improving compatibility with GitHub rendering.
 - Improved build status badge aesthetics in the README.
 
 ## [0.1.0] - 2024-02-24
 
 ### Added
 
-- Upgraded package version from 0.0 to 0.1.0.
-- Initial release as a Python package with full Google Colab integration.
-- Basic API functionality including dynamic model loading and inference endpoints.
-- Enhanced logging with ASCII art banners, detailed model and system resource information, and robust error handling.
-- Ngrok tunnel management for public URL access in Colab.
-- Comprehensive documentation with absolute URLs for smooth navigation.
-- GitHub Actions workflow for automated PyPI publishing.
-- MIT License introduced.
+- Initial release as a Python package with full Google Colab integration, dynamic model loading, robust logging (with ASCII art banners), API endpoints for text generation and system monitoring, Ngrok tunnel management, and comprehensive documentation.

README.md

@@ -1,7 +1,6 @@
 # 🚀 LocalLab
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/Developer-Utkarsh/LocalLab/ci.yml?style=flat-square)](https://github.com/Developer-Utkarsh/LocalLab/actions)
-[![Coverage Status](https://coveralls.io/repos/github/Developer-Utkarsh/LocalLab/badge.svg?branch=main&style=flat-square)](https://coveralls.io/github/Developer-Utkarsh/LocalLab?branch=main)
 [![LocalLab Version](https://img.shields.io/pypi/v/locallab.svg?style=flat-square)](https://pypi.org/project/locallab/)
 [![Python Version](https://img.shields.io/pypi/pyversions/locallab.svg?style=flat-square)](https://pypi.org/project/locallab/)
 [![License](https://img.shields.io/github/license/Developer-Utkarsh/LocalLab.svg?style=flat-square)](https://github.com/Developer-Utkarsh/LocalLab/blob/main/LICENSE)
@@ -50,13 +49,13 @@ LocalLab is a powerful, lightweight AI inference server designed to deliver cutt
 Below is a high-level diagram of LocalLab's architecture.
 
 ```mermaid
-graph TD;
-    A["User"] --> B["LocalLab Client (Python/Node.js)"];
-    B --> C["LocalLab Server"];
-    C --> D["Model Manager"];
-    D --> E["Hugging Face Models"];
-    C --> F["Optimizations"];
-    C --> G["Resource Monitoring"];
+graph TD
+    A["User"] --> B["LocalLab Client (Python/Node.js)"]
+    B --> C["LocalLab Server"]
+    C --> D["Model Manager"]
+    D --> E["Hugging Face Models"]
+    C --> F["Optimizations"]
+    C --> G["Resource Monitoring"]
 ```
 
 ## Google Colab Workflow

locallab/__init__.py

@@ -2,7 +2,7 @@
 LocalLab - A lightweight AI inference server
 """
 
-__version__ = "0.1.3" 
+__version__ = "0.1.4" 
 
 from typing import Dict, Any, Optional
 

locallab/main.py

@@ -376,7 +376,6 @@ async def startup_event():
     ╚══════╝ ╚═════╝  ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝  ╚═╝╚═════╝ 
 {Style.RESET_ALL}"""
 
-        # In Google Colab, explicitly print the banner to ensure visibility
         print(banner)
         sys.stdout.flush()
         logger.info(banner)
@@ -430,10 +429,10 @@ async def startup_event():
         logger.info(model_config)
         sys.stdout.flush()
 
-        # Load model with progress indicator
+        # Load model with progress indicator (start in background to not block startup)
         logger.info(f"\n{Fore.YELLOW}⚡ Loading model: {hf_model}{Style.RESET_ALL}")
-        await model_manager.load_model(hf_model)
-        logger.info(f"{Fore.GREEN}✓ Model loaded successfully!{Style.RESET_ALL}\n")
+        asyncio.create_task(model_manager.load_model(hf_model))
+        logger.info(f"{Fore.GREEN}Model loading started in background!{Style.RESET_ALL}\n")
         sys.stdout.flush()
 
         # System Resources with box drawing
@@ -509,7 +508,7 @@ async def startup_event():
     ╔════════════════════════════════════════════════════════════════════╗
     ║                                                                  ║
     ║  {Fore.GREEN}LocalLab - Your Local AI Inference Server{Fore.CYAN}                    ║
-    ║  {Fore.GREEN}Made with ❤️  by Utkarsh Tiwari{Fore.CYAN}                             ║
+    ║  {Fore.GREEN}Made with ❤️  by Utkarsh{Fore.CYAN}                             ║
     ║                                                                  ║
     ╚══════════════════════════════════════════════════════════════════╝{Style.RESET_ALL}
 
@@ -714,8 +713,7 @@ def run_server_proc(log_queue):
         logger.error(f"Server startup failed: {str(e)}")
         raise
 
-# Modify start_server to accept a log_queue parameter and pass it to the child process
-
+# Modify start_server function
 def start_server(use_ngrok: bool = False, log_queue=None):
     import time
     import requests
@@ -724,14 +722,20 @@ def start_server(use_ngrok: bool = False, log_queue=None):
     if log_queue is None:
         ctx = multiprocessing.get_context("spawn")
         log_queue = ctx.Queue()
-    
+
+    # If using ngrok, set environment variable to trigger colab branch in run_server_proc
+    if use_ngrok:
+        os.environ["COLAB_GPU"] = "1"
+        timeout = 60
+    else:
+        timeout = 30
+
     # Start the server in a separate process using spawn context with module-level run_server_proc
     ctx = multiprocessing.get_context("spawn")
     p = ctx.Process(target=run_server_proc, args=(log_queue,))
     p.start()
-    
+
     # Wait until the /health endpoint returns 200 or timeout
-    timeout = 30
     start_time_loop = time.time()
     health_url = "http://127.0.0.1:8000/health"
     server_ready = False
@@ -744,10 +748,10 @@ def start_server(use_ngrok: bool = False, log_queue=None):
         except Exception:
             pass
         time.sleep(1)
-    
+
     if not server_ready:
         raise Exception("Server did not become healthy in time.")
-    
+
     if use_ngrok:
         public_url = setup_ngrok(port=8000)
         ngrok_section = f"\n{Fore.CYAN}┌────────────────────────── Ngrok Tunnel Details ─────────────────────────────┐{Style.RESET_ALL}\n│\n│  🚀 Ngrok Public URL: {Fore.GREEN}{public_url}{Style.RESET_ALL}\n│\n{Fore.CYAN}└──────────────────────────────────────────────────────────────────────────────┘{Style.RESET_ALL}\n"

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="locallab",
-    version="0.1.3",
+    version="0.1.4",
     packages=find_packages(include=["locallab", "locallab.*"]),
     install_requires=[
         "fastapi>=0.68.0,<1.0.0",