Merge pull request #231 from hand-e-fr/3.0.0_beta1

Author: battmanux

.github/workflows/quality_check.yml

@@ -44,7 +44,7 @@ jobs:
           python-version: "3.12"
 
       - name: Install dependencies
-        run: pip install .[dev,pydantic]
+        run: pip install .[dev]
 
       - name: Run autopep8
         run: python -m autopep8 --recursive --in-place src/OpenHosta
@@ -67,7 +67,7 @@ jobs:
           python-version: "3.12"
 
       - name: Install dependencies
-        run: pip install .[dev,pydantic]
+        run: pip install .[dev]
 
       - name: Run mypy
         run: python -m mypy src/OpenHosta
@@ -81,7 +81,7 @@ jobs:
         run: python -m bandit -c pyproject.toml -r src/OpenHosta -f txt
         continue-on-error: true
 
-  unit-tests:
+  functionnal-tests:
     needs: setup
     runs-on: ubuntu-latest
     steps:
@@ -92,28 +92,18 @@ jobs:
 
       - name: Install dependencies
         run: pip install .[tests]
-        
-      - name: Run unit tests
-        run: python -m pytest tests/unitTests -v --cov=OpenHosta.core
 
-  functional-tests:
-    needs: setup
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-          
-      - name: Install dependencies
-        run: pip install .[tests]
-      - name: Run functional tests
+      - name: create .env file
+        run: |
+          echo "OPENHOSTA_DEFAULT_MODEL_API_KEY=${{ secrets.OPENHOSTA_DEFAULT_MODEL_API_KEY }}" >> .env
+
+      - name: Run functionnal tests
         env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}         
-        run: python -m pytest tests/functionnalTests -v --cov=OpenHosta
+          OPENHOSTA_DEFAULT_MODEL_API_KEY: ${{ secrets.OPENHOSTA_DEFAULT_MODEL_API_KEY }}         
+        run: python -m pytest tests/functionnal -v --cov=OpenHosta
 
   notify:
-    needs: [code-quality, static-analysis, unit-tests, functional-tests]
+    needs: [code-quality, static-analysis, functionnal-tests]
     runs-on: ubuntu-latest
     if: always()
     steps:

.gitignore

@@ -19,5 +19,6 @@ build/
 mypy/
 .mypy_cache/
 linter.py
-*pt.py
-tests/reports/*report.txt
+tests/reports/*report.txt
+tests/functionnalTests/.env
+**/.env

CHANGELOG.md

@@ -20,7 +20,7 @@ All significant changes to this project will be documented in this file.
 
 - **Fixes**
   - #195 fix Bug with pydantic import
-  - #199 improve pydantic return type support for List[BaseModel] and Dict[..., BaseModel]
+  - #199 improve pydantic return type support for List[Model] and Dict[..., Model]
 
 ## **v2.1.5**
 - **Fixes**
@@ -42,7 +42,7 @@ All significant changes to this project will be documented in this file.
 
 ## **v2.1.3**
 - **Features**
-  - Added `additionnal_headers` in `Model` to add specific values in the header of the request send to the API.
+  - Added `additionnal_headers` in `OpenAICompatibleModel` to add specific values in the header of the request send to the API.
   - `ask` can now be used without specify the `user` parameter name.
 
 - **Fixes**
@@ -57,7 +57,7 @@ All significant changes to this project will be documented in this file.
 
 ## **v2.1.2**
 - **Doc**
-  - Fix the example for the custom Model class with a Llama Model
+  - Fix the example for the custom OpenAICompatibleModel class with a Llama OpenAICompatibleModel
 
 - **Fixes**
   - Remove the PIL dependency
@@ -67,7 +67,7 @@ All significant changes to this project will be documented in this file.
   - Changed examples syntax in the system prompt for better performances.
 
 - **Doc**
-  - Added an example for a custom Model class with an Llama model.  
+  - Added an example for a custom OpenAICompatibleModel class with an Llama model.  
 
 ## **v2.0-beta2**
 - **Added**
@@ -131,7 +131,7 @@ All significant changes to this project will be documented in this file.
 ## **v1.1.1** 10/07/24
 
 - **Features**
-  - Added `_last_request` attributs to the `Model` object
+  - Added `_last_request` attributs to the `OpenAICompatibleModel` object
 
 - **Optimization**
   - Reduce the `emulate`'s user prompt to only the function call string and move the rest in the system prompt.
@@ -179,7 +179,7 @@ All significant changes to this project will be documented in this file.
   - the `emulate` function is now decorator-resistant.
   - The function `config.set_default_model` works now w/ `config.set_default_apiKey`
   - `thought` function now accept multiple arguments
-  - `suggest` and `analytics` call now th LLM with `Model` class (`ai_call`)
+  - `suggest` and `analytics` call now th LLM with `OpenAICompatibleModel` class (`ai_call`)
   - `emulate` works now in a nested function.
   - Added Flask compatibility
 

README.md

@@ -1,21 +1,70 @@
 # OpenHosta 
-v2.2.2 - Open-Source Project
 
-<a href="https://colab.research.google.com/github/hand-e-fr/OpenHosta/blob/main/docs/openhosta_mistral_small.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> Basic Usage - local LLM (Mistral-Small-2501)</a>
-<br/>
-<a href="https://colab.research.google.com/github/hand-e-fr/OpenHosta/blob/main/docs/openhosta_phi4.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> Basic Usage - Synthetic Data - local LLM (phi-4)</a>
-<br/>
-<a href="https://colab.research.google.com/github/hand-e-fr/OpenHosta/blob/main/docs/openhosta_agent.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> Simple AI Agent with gpt-4o</a>
-<br/>Or have a look at [regression tests files](https://github.com/hand-e-fr/OpenHosta/tree/main/tests/non-regression) for multiples exemples.
+v3.0.0 - Integrates Inria Comments
 
-OpenHosta is a powerful Python tool designed to seamlessly integrate Large Language Models (LLMs) into development environments, enabling AI-powered function emulation that maintains native Python syntax and paradigms. Its strength lies in its simplicity and flexibility, allowing developers to easily create AI-enhanced applications while maintaining clean, Pythonic code structure.
+<br/>You can read the doc or directly have a look at [tests files](https://github.com/hand-e-fr/OpenHosta/tree/main/tests/) for multiples exemples.
 
-**- The future of development is human -**
+OpenHosta is a powerful Python extension designed to seamlessly integrate semantic capabilities seen in Large Language Models (LLMs) into tradictional development environments, enabling AI-powered function emulation that maintains native Python syntax and paradigms. Its strength lies in its simplicity and flexibility, allowing developers to easily create AI-enhanced applications while maintaining clean, Pythonic code structure.
+
+OpenHosta can run fully offline with a local model, or use a remote model via API key.
 
-Welcome to the OpenHosta documentation, a powerful tool that facilitates the integration LLM in the development environnement. OpenHosta is used to emulate functions using AI, while respecting Python's native paradygma and syntax.
+**- The future of development is human -**
 
 For this project, we have adopted a [Code of Conduct](https://github.com/hand-e-fr/OpenHosta/blob/main/CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all contributors. Please take a moment to read it.
 
+The simplest usage of OpenHosta is to allow semantic tests in your code, like this:
+
+```python
+from OpenHosta import test
+
+sentence = "You are an nice person."
+# You shall try with this too:
+# sentence = "You are a stupid #@!!~uk."
+
+if test(f"this contains an insult: {sentence}"):
+    print("The sentence is considered an insult.")
+else:
+    print("The sentence is not considered an insult.")
+
+# The sentence is not considered an insult.
+```
+
+But the most powerful feature of OpenHosta is the `emulate` function, which allows you to define a function with a docstring and let OpenHosta implement it for you using AI. The `emulate` function supports basic python types, dataclasses, pydantic, enums and Images. You can use all these types as input and output of the function (except for Images which can only be input).
+
+```python
+from OpenHosta import emulate
+
+from enum import Enum
+class DocumentType(Enum):
+    OLD_BOOK = "old_book"
+    ARTICLE = "article"
+    REPORT = "report"
+    THESIS = "thesis"
+
+from PIL.Image import Image, open
+
+def classify_document(page:Image)->DocumentType:
+    """
+    This function classifies the document based on the content of the page givent in parameter.
+    
+    Arguments:
+    page: An image of the document page to classify.
+
+    Returns:
+    DocumentType: The type of the document
+    """
+    return emulate()
+
+import requests
+url=r"https://www.inria.fr/sites/default/files/2024-01/A_outil_innovant_caracte%CC%81riser_plantes_1827x1026_bonnier-2.png"
+img = open(requests.get(url, stream=True).raw)
+
+result = classify_document(img)
+
+result
+# <DocumentType.OLD_BOOK: 'old_book'>
+```
+
 ## Table of Content
 
 - [OpenHosta](#openhosta)
@@ -40,17 +89,31 @@ pip install OpenHosta
 or
 
 ```sh
-git clone https://github.com/hand-e-fr/OpenHosta.git
+pip install https://github.com/hand-e-fr/OpenHosta.git
 ```
 
-**See the full installation guide [here](https://github.com/hand-e-fr/OpenHosta/blob/main/docs/installation.md)**
+or for a specific branch
+
+```sh
+pip install "git+https://github.com/hand-e-fr/OpenHosta.git@unstable" # for the latest unstable version
+```
+
+**See the full [installation guide](https://github.com/hand-e-fr/OpenHosta/blob/main/docs/installation.md)**
 
 ## Example
 
-```python
-from OpenHosta import emulate, config
+You shall set your API credentials either via environment variables or directly in your code.
+For now we assume that you have an OpenAI API key and that you have set it in .env like this:
+
+```env
+OPENHOSTA_DEFAULT_MODEL_NAME="gpt-4.1"
+OPENHOSTA_DEFAULT_MODEL_API_KEY="put-your-api-key-here"
+```
 
-config.set_default_apiKey("put-your-api-key-here")
+You can also use a local model using ollama. See [documentation](https://github.com/hand-e-fr/OpenHosta/blob/main/docs/installation.md#local-models).
+
+```python
+from OpenHosta import emulate
 
 def translate(text:str, language:str)->str:
     """
@@ -59,9 +122,12 @@ def translate(text:str, language:str)->str:
     return emulate()
 
 result = translate("Hello World!", "French")
+
 print(result)
+# Bonjour le monde !
 ```
-You check OpenHosta's [documentation](https://github.com/hand-e-fr/OpenHosta/blob/main/docs/doc.md) for more detailled informations or exemple
+
+You check [OpenHosta's documentation](https://github.com/hand-e-fr/OpenHosta/blob/main/docs/doc.md) for more detailled informations or exemple
 
 ## Further information