👔 Project settings is now encapsulated into guidellm.config module (#17)

* The module is currently has only `__init__` file
* All `os.getenv` replaced with `pydantic_settings` facade
* `GUIDELLM__` env prefix is set

---------

Co-authored-by: Dmytro Parfeniuk <[email protected]>

Author: parfeniukink

.env.example

@@ -10,26 +10,29 @@ This document aims to provide developers with all the necessary information to c
 ### Prerequisites
 
 Before you begin, ensure you have the following installed:
+
 - Python 3.8 or higher
 - `pip` (Python package installer)
 - `git` (version control system)
 
 ### Installation
 
 1. Clone the repository:
-    ```bash
-    git clone https://github.com/neuralmagic/guidellm.git
-    cd guidellm
-    ```
+
+   ```bash
+   git clone https://github.com/neuralmagic/guidellm.git
+   cd guidellm
+   ```
 
 2. Install the required dependencies:
-    ```bash
-    pip install -e .[dev]
-    ```
+   ```bash
+   pip install -e .[dev]
+   ```
 
 ## Project Structure
 
 The project follows a standard Python project structure:
+
 ```plaintext
 guidellm/
 ├── src/
@@ -51,14 +54,15 @@ guidellm/
 To set up your development environment, follow these steps:
 
 1. Install pre-commit hooks:
-    ```bash
-    pre-commit install
-    ```
+
+   ```bash
+   pre-commit install
+   ```
 
 2. Ensure all dependencies are installed:
-    ```bash
-    pip install -e .[dev]
-    ```
+   ```bash
+   pip install -e .[dev]
+   ```
 
 ## Code Quality and Style Guidelines
 
@@ -70,39 +74,39 @@ Ruff is used for linting and formatting checks.
 
 - Configuration is in `pyproject.toml`.
 - To run Ruff:
-    ```bash
-    ruff check src tests
-    ```
+  ```bash
+  ruff check src tests
+  ```
 
 ### Isort
 
 Isort is used for sorting imports.
 
 - Configuration is in `pyproject.toml`.
 - To sort imports:
-    ```bash
-    isort src tests
-    ```
+  ```bash
+  isort src tests
+  ```
 
 ### Flake8
 
 Flake8 is used for linting.
 
 - Configuration is in `tox.ini`.
 - To run Flake8:
-    ```bash
-    flake8 src tests --max-line-length 88
-    ```
+  ```bash
+  flake8 src tests --max-line-length 88
+  ```
 
 ### MyPy
 
 MyPy is used for type checking.
 
 - Configuration is in `pyproject.toml`.
 - To run MyPy:
-    ```bash
-    mypy src/guidellm
-    ```
+  ```bash
+  mypy src/guidellm
+  ```
 
 ## Testing
 
@@ -111,6 +115,7 @@ We use `pytest` for running tests.
 ### Running All Tests
 
 To run all tests:
+
 ```bash
 tox
 ```
@@ -150,6 +155,7 @@ tox -e test-e2e
 ```
 
 ## Formatting, Linting, and Type Checking
+
 ### Running Quality Checks (Linting)
 
 To run quality checks (ruff, isort, flake8, mypy), use the following command:
@@ -204,6 +210,24 @@ Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to
 
 Please refer to the MAINTAINERS file for maintenance guidelines and contact information.
 
+## Project configuration
+
+The project configuartion is powered by _[`🔗 pydantic-settings`](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)_
+
+The project configuration entry point is represented by lazy-loaded `settigns` singleton object ( `src/config/__init__` )
+
+The project is fully configurable with environment variables. With that configuration set you can load parameters to `LoggingSettings()` by using environment variables. Just run `export GUIDELLM__LOGGING__DISABLED=true` or `export GUIDELLM__LOGGING__NESTED=another_value` respectfully. The nesting delimiter is `__`.
+
+### Environment variables
+
+| Name                           | Default value           | Description                                                                                                                                             |
+| ------------------------------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `GUIDELLM__LOGGING__DISABLED`  | `False`                 | Determines whether logger for the `guidellm` package is disabled or not                                                                                 |
+| `GUIDELLM__LOGGING__LOG_LEVEL` | `INFO`                  | The level of `guidellm` package logging                                                                                                                 |
+| `GUIDELLM__LOGGING__LOG_FILE`  | `guidellm.log`          | The name of a log file                                                                                                                                  |
+| `GUIDELLM__OPENAI__BASE_URL`   | `http://localhost:8080` | The address to the **OpenAI-compatible** server.<br><br>OpenAI live base url is `https://api.openai.com/v1`                                             |
+| `GUIDELLM__OPENAI__API_KEY`    | `invalid`               | Corresponds to the **OpenAI-compatible** server API key.<br><br>If you look for the live key - check [this link](https://platform.openai.com/api-keys). |
+
 ## Contact and Support
 
 If you need help or have any questions, please open an issue on GitHub or contact us at [email protected].

DEVELOPING.md

@@ -31,6 +31,7 @@ dependencies = [
     "numpy",
     "openai",
     "pydantic>=2.0.0",
+    "pydantic-settings>=2.0.0",
     "pyyaml>=6.0.0",
     "requests",
     "transformers",

pyproject.toml

@@ -0,0 +1,52 @@
+from typing import Optional
+
+from pydantic import BaseModel
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+__all__ = ["settings"]
+
+
+class LoggingSettings(BaseModel):
+    disabled: bool = False
+    clear_loggers: bool = True
+    console_log_level: str = "INFO"
+    log_file: Optional[str] = None
+    log_file_level: Optional[str] = None
+
+
+class OpenAISettings(BaseModel):
+
+    # OpenAI API key.
+    api_key: str = "invalid"
+
+    # OpenAI-compatible server URL
+    # NOTE: The default value is default address of llama.cpp web server
+    base_url: str = "http://localhost:8080"
+
+
+class Settings(BaseSettings):
+    """
+    All the settings are powered by pydantic_settings and could be
+    populated from the .env file.
+
+    The format to populate the settings is next
+
+    ```sh
+    export GUIDELLM__LOGGING__DISABLED=true
+    export GUIDELLM__OPENAI__API_KEY=******
+    ```
+
+    """
+
+    model_config = SettingsConfigDict(
+        env_prefix="GUIDELLM",
+        env_nested_delimiter="__",
+        env_file=".env",
+        extra="ignore",
+    )
+
+    logging: LoggingSettings = LoggingSettings()
+    openai: OpenAISettings = OpenAISettings()
+
+
+settings = Settings()

src/config/__init__.py

@@ -3,10 +3,6 @@
 evaluating and benchmarking large language models (LLMs).
 """
 
-from .logger import LoggerConfig, configure_logger, logger
+from .logger import configure_logger, logger
 
-__all__ = [
-    "logger",
-    "configure_logger",
-    "LoggerConfig",
-]
+__all__ = ["logger", "configure_logger"]

src/guidellm/__init__.py

@@ -1,12 +1,12 @@
 import functools
-import os
 from typing import Any, Dict, Generator, List, Optional
 
 from loguru import logger
 from openai import OpenAI, Stream
 from openai.types import Completion
 from transformers import AutoTokenizer
 
+from config import settings
 from guidellm.backend import Backend, BackendEngine, GenerativeResponse
 from guidellm.core import TextGenerationRequest
 
@@ -47,18 +47,16 @@ def __init__(
 
         self.request_args = request_args
 
-        if not (_api_key := (openai_api_key or os.getenv("OPENAI_API_KEY", None))):
+        if not (_api_key := (openai_api_key or settings.openai.api_key)):
             raise ValueError(
-                "`OPENAI_API_KEY` environment variable "
+                "`GUIDELLM__OPENAI__API_KEY` environment variable "
                 "or --openai-api-key CLI parameter "
                 "must be specify for the OpenAI backend"
             )
 
-        if not (
-            _base_url := (internal_callback_url or os.getenv("OPENAI_BASE_URL", None))
-        ):
+        if not (_base_url := (internal_callback_url or settings.openai.base_url)):
             raise ValueError(
-                "`OPENAI_BASE_URL` environment variable "
+                "`GUIDELLM__OPENAI__BASE_URL` environment variable "
                 "or --openai-base-url CLI parameter "
                 "must be specify for the OpenAI backend"
             )