Config

README.md

@@ -68,4 +68,18 @@ To use these configuration values:
 2. Replace the placeholder values in `config.yaml` with your actual configuration.
 3. The application will automatically read these values from the `config.yaml` file.
 
-Note: Make sure not to commit your `config.yaml` file with sensitive information to version control. Add it to your `.gitignore` file to prevent accidental commits.
+## Configuration
+
+The project uses a flexible configuration system that allows for both local development and deployment:
+
+1. For local development:
+   - Copy the `config.yaml.example` file to `config.yaml`.
+   - Replace the placeholder values in `config.yaml` with your actual configuration.
+   - The application will automatically read these values from the `config.yaml` file.
+
+2. For deployment (e.g., to Hugging Face):
+   - The `config.yaml` file is not required and should not be included in the repository.
+   - Set the `HF_TOKEN` environment variable with your Hugging Face API token.
+   - Other configuration values will use sensible defaults if not specified.
+
+Note: Make sure not to commit your `config.yaml` file with sensitive information to version control. It is already added to the `.gitignore` file to prevent accidental commits.

config.yaml.example

@@ -1,6 +1,6 @@
 # API and Token configurations
 api_token: YOUR_API_TOKEN_HERE
-queue_repo: YOUR_QUEUE_REPO_HERE
+queue_repo: stacklok/requests
 
 # File paths
 eval_requests_path: ./eval-queue

src/config.py

@@ -1,9 +1,21 @@
 import yaml
+import os
 from typing import List, Dict, Any
 
 def load_config() -> Dict[str, Any]:
-    with open('config.yaml', 'r') as file:
-        return yaml.safe_load(file)
+    if os.path.exists('config.yaml'):
+        with open('config.yaml', 'r') as file:
+            config = yaml.safe_load(file)
+    else:
+        raise FileNotFoundError("config.yaml not found. Please create it based on config.yaml.example.")
+
+    # Ensure required configurations are present
+    required_configs = ['api_token', 'queue_repo', 'eval_requests_path', 'eval_results_path']
+    for config_name in required_configs:
+        if config_name not in config:
+            raise ValueError(f"Required configuration '{config_name}' is missing in config.yaml")
+
+    return config
 
 config = load_config()