documentation: create v0 documentation

Author: leoguillaume

.github/compose.ci.yml

@@ -7,8 +7,6 @@ services:
       dockerfile: api/Dockerfile
     restart: always
     env_file: "${APP_ENV_FILE:-.env.ci}"
-    volumes:
-      - ../scripts/generate_configuration_documentation.py:/scripts/generate_configuration_documentation.py:ro
     ports:
       - 8000:8000
     environment:

.github/workflows/generate_documentation.yml

@@ -13,27 +13,26 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+      - name: Checkout du code
+        uses: actions/checkout@v4
 
-    - name: Set up Docker Compose
-      run: |
-        cp .github/.env.ci.example .github/.env.ci
-        sed -i 's/^\([A-Z_]*\)_HOST=localhost/\1_HOST=\L\1/' .github/.env.ci
-        make test-integ action=up execute=docker
-      env:
-        BRAVE_API_KEY: ${{ secrets.BRAVE_API_KEY }}
-        ALBERT_API_KEY: ${{ secrets.ALBERT_API_KEY }}
-        CS_API_KEY: ${{ secrets.CS_API_KEY }}
+      - name: Configure Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
 
-    - name: Generate configuration documentation
-      run: |
-        docker compose -f .github/compose.ci.yml --env-file .github/.env.ci run -T --user $(id -u):$(id -g) -v $(pwd)/api:/api api \
-        python /scripts/generate_configuration_documentation.py --output /api/configuration.md
-        
-        cat ./api/configuration.md > ./docs/docs/getting-started/configuration.md
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[api,dev]"
 
-    - name: Commit configuration documentation
-      uses: stefanzweifel/git-auto-commit-action@v4
-      with:
-        commit_message: Update configuration documentation
-        file_pattern: ./docs/getting-started/configuration.md
+      - name: Generate documentation
+        run: |
+          PYTHONPATH=. python ./scripts/docs/generate_configuration_documentation.py --output ./docs/docs/getting-started/configuration.md
+          PYTHONPATH=. python ./scripts/docs/convert_notebooks_to_docs.py --input ./docs/tutorials --output ./docs/docs/guides
+
+      - name: Commit documentation
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Update docs
+          file_pattern: ./docs/getting-started/configuration.md ./docs/docs/guides/*.md

CONTRIBUTING.md

@@ -178,14 +178,3 @@ Then apply the migration with the following command:
 ```bash
 alembic -c playground/alembic.ini upgrade head
 ```
-
-## Generate configuration documentation
-
-To generate the configuration documentation, you can use the following command:
-
-```bash
-python scripts/generate_configuration_documentation.py
-```
-
-> [!NOTE]
-> This will generate the configuration documentation in the *[docs/docs/getting-started/configuration.md](./docs/docs/getting-started/configuration.md)* file from the [configuration schema](./api/schemas/core/configuration.py) with the [configuration header](./scripts/configuration_header.md).

README.md

@@ -6,7 +6,7 @@
 <img src="./docs/static/img/ogl_logo.svg" alt="Logo" width="128" height="128">
 
 # OpenGateLLM
-[Documentation](https://docs.opengatellm.etalab.gouv.fr) | [API Reference](https://albert.api.etalab.gouv.fr/documentation)
+### **[Documentation](https://docs.opengatellm.etalab.gouv.fr) | [API Reference](https://albert.api.etalab.gouv.fr/documentation)**
 
 > [!WARNING]
 > **The API is still under beta version, major breaking changes may occur.**

api/schemas/core/configuration.py

@@ -15,8 +15,8 @@
 from api.utils.variables import (
     DEFAULT_APP_NAME,
     DEFAULT_TIMEOUT,
-    ROUTER__AUTH,
     ROUTER__ADMIN,
+    ROUTER__AUTH,
     ROUTERS,
 )
 
@@ -118,7 +118,7 @@ class ModelProvider(ConfigBaseModel):
     model_name: constr(strip_whitespace=True, min_length=1) = Field(..., description="Model name from the model provider.", examples=["gpt-4o"])  # fmt: off
     model_cost_prompt_tokens: float = Field(default=0.0, ge=0.0, description="Model costs prompt tokens for user budget computation. The cost is by 1M tokens.", examples=[0.1])  # fmt: off
     model_cost_completion_tokens: float = Field(default=0.0, ge=0.0, description="Model costs completion tokens for user budget computation. The cost is by 1M tokens.", examples=[0.1])  # fmt: off
-    model_carbon_footprint_zone: CountryCodes = Field(default=CountryCodes.WOR, description="Model hosting zone for carbon footprint computation (with ISO 3166-1 alpha-3 code format). For more information, see https://ecologits.ai", examples=["WOR"])  # fmt: off
+    model_carbon_footprint_zone: CountryCodes = Field(default=CountryCodes.WOR, description="Model hosting zone using ISO 3166-1 alpha-3 code format (e.g., `WOR` for World, `FRA` for France, `USA` for United States). This determines the electricity mix used for carbon intensity calculations. For more information, see https://ecologits.ai", examples=["WOR"])  # fmt: off
     model_carbon_footprint_total_params: Optional[float] = Field(default=None, ge=0.0, description="Total params of the model in billions of parameters for carbon footprint computation. If not provided, the active params will be used if provided, else carbon footprint will not be computed. For more information, see https://ecologits.ai", examples=[8])  # fmt: off
     model_carbon_footprint_active_params: Optional[float] = Field(default=None, ge=0.0, description="Active params of the model in billions of parameters for carbon footprint computation. If not provided, the total params will be used if provided, else carbon footprint will not be computed. For more information, see https://ecologits.ai", examples=[8])  # fmt: off
 
@@ -251,10 +251,6 @@ class BraveDependency(ConfigBaseModel):
     timeout: int = Field(default=DEFAULT_TIMEOUT, ge=1, description="Timeout for the Brave API requests.", examples=[10])  # fmt: off
 
 
-class CentraleSupelecDependency(ConfigBaseModel):
-    token: str = Field(description="Centrale Supélec token for testing dynamic models")
-
-
 @custom_validation_error(url="https://github.com/etalab-ia/opengatellm/blob/main/docs/configuration.md#duckduckgodependency")
 class DuckDuckGoDependency(ConfigBaseModel):
     url: constr(strip_whitespace=True, min_length=1) = Field(default="https://api.duckduckgo.com/", description="DuckDuckGo API url.")  # fmt: off
@@ -341,7 +337,6 @@ class EmptyDepencency(ConfigBaseModel):
 class Dependencies(ConfigBaseModel):
     albert: Optional[AlbertDependency] = Field(default=None, description="If provided, Albert API is used to parse pdf documents. Cannot be used with Marker dependency concurrently. Pass arguments to call Albert API in this section.")  # fmt: off
     brave: Optional[BraveDependency] = Field(default=None, description="If provided, Brave API is used to web search. Cannot be used with DuckDuckGo dependency concurrently. Pass arguments to call API in this section. All query parameters are supported, see https://api-dashboard.search.brave.com/app/documentation/web-search/query for more information.")  # fmt: off
-    centralesupelec: Optional[CentraleSupelecDependency] = Field(default=None, description="Needed to pass tests where models are added")
     duckduckgo: Optional[DuckDuckGoDependency] = Field(default=None, description="If provided, DuckDuckGo API is used to web search. Cannot be used with Brave dependency concurrently. Pass arguments to call API in this section. All query parameters are supported, see https://www.searchapi.io/docs/duckduckgo-api for more information.")  # fmt: off
     elasticsearch: Optional[ElasticsearchDependency] = Field(default=None, description="Pass all elastic python SDK arguments, see https://elasticsearch-py.readthedocs.io/en/v9.0.2/api/elasticsearch.html#elasticsearch.Elasticsearch for more information.")  # fmt: off
     qdrant: Optional[QdrantDependency] = Field(default=None, description="Pass all qdrant python SDK arguments, see https://python-client.qdrant.tech/qdrant_client.qdrant_client for more information.")  # fmt: off
@@ -494,7 +489,7 @@ def validate_model(cls, values) -> Any:
 @custom_validation_error(url="https://github.com/etalab-ia/opengatellm/blob/main/docs/configuration.md#all-configuration")
 class ConfigFile(ConfigBaseModel):
     """
-    Refer to the [configuration example file](../../../config.example.yml) for an example of configuration.
+    Refer to the [configuration example file](https://github.com/etalab-ia/OpenGateLLM/blob/main/config.example.yml) for an example of configuration.
     """
 
     models: List[Model] = Field(min_length=1, description="Models used by the API. At least one model must be defined.")  # fmt: off