feat: Framework moved to a sub-folder

Libertai · Oct 18, 2024 · 14e0303 · 14e0303
1 parent ab33714
commit 14e0303
Show file tree

Hide file tree

Showing 20 changed files with 116 additions and 108 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -4,9 +4,12 @@ on:
   push:
 
 jobs:
-  mypy:
-    name: mypy
+  package-mypy:
+    name: "Package: mypy"
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./libertai_agents
     steps:
       - uses: actions/checkout@v4
       - name: Install poetry
@@ -21,19 +24,24 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           reporter: github-check
-          target: libertai_agents
+          workdir: './libertai_agents'
+          target: "./libertai_agents"
           execute_command: 'poetry run mypy'
 
   ruff:
-    name: ruff
+    name: "Package: ruff"
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./libertai_agents
     steps:
       - uses: actions/checkout@v4
       - name: Install poetry
         run: pipx install poetry
       - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
+          cache: 'poetry'
       - name: Install dependencies
         run: pip install ruff
       - name: Run Ruff

diff --git a/.gitignore b/.gitignore
@@ -1,2 +0,0 @@
-/venv
-/dist

diff --git a/libertai_agents/.gitignore b/libertai_agents/.gitignore
@@ -0,0 +1,2 @@
+/venv
+/dist
diff --git a/libertai_agents/README.md b/libertai_agents/README.md
@@ -0,0 +1,16 @@
+# LibertAI Agents
+
+## Supported models
+
+We support multiple open-source models that have agentic capabilities.
+
+- [Hermes 2 Pro - Llama 3 8B](https://huggingface.co/NousResearch/Hermes-2-Pro-Llama-3-8B)
+- ⏳ [Hermes 3 - Llama-3.1 8B](https://huggingface.co/NousResearch/Hermes-3-Llama-3.1-8B)
+- ⏳ [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407)
+
+## Using a gated model
+
+Some models, like [Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) are gated (
+generally to require you to accept some usage conditions).\
+To use those models, you need to create an [access token](https://huggingface.co/settings/tokens) from your Hugging Face
+account and give it to the `get_model` function.
diff --git a/libertai_agents/__init__.py → libertai_agents/libertai_agents/__init__.py b/libertai_agents/__init__.py → libertai_agents/libertai_agents/__init__.py
diff --git a/libertai_agents/agents.py → libertai_agents/libertai_agents/agents.py b/libertai_agents/agents.py → libertai_agents/libertai_agents/agents.py
diff --git a/libertai_agents/interfaces/__init__.py → ...ts/libertai_agents/interfaces/__init__.py b/libertai_agents/interfaces/__init__.py → ...ts/libertai_agents/interfaces/__init__.py
diff --git a/libertai_agents/interfaces/llamacpp.py → ...ts/libertai_agents/interfaces/llamacpp.py b/libertai_agents/interfaces/llamacpp.py → ...ts/libertai_agents/interfaces/llamacpp.py
diff --git a/libertai_agents/interfaces/messages.py → ...ts/libertai_agents/interfaces/messages.py b/libertai_agents/interfaces/messages.py → ...ts/libertai_agents/interfaces/messages.py
diff --git a/libertai_agents/interfaces/models.py → ...ents/libertai_agents/interfaces/models.py b/libertai_agents/interfaces/models.py → ...ents/libertai_agents/interfaces/models.py
diff --git a/libertai_agents/models/__init__.py → ...agents/libertai_agents/models/__init__.py b/libertai_agents/models/__init__.py → ...agents/libertai_agents/models/__init__.py
diff --git a/libertai_agents/models/base.py → ...tai_agents/libertai_agents/models/base.py b/libertai_agents/models/base.py → ...tai_agents/libertai_agents/models/base.py
diff --git a/libertai_agents/models/hermes.py → ...i_agents/libertai_agents/models/hermes.py b/libertai_agents/models/hermes.py → ...i_agents/libertai_agents/models/hermes.py
diff --git a/libertai_agents/models/mistral.py → ..._agents/libertai_agents/models/mistral.py b/libertai_agents/models/mistral.py → ..._agents/libertai_agents/models/mistral.py
diff --git a/libertai_agents/models/models.py → ...i_agents/libertai_agents/models/models.py b/libertai_agents/models/models.py → ...i_agents/libertai_agents/models/models.py
diff --git a/libertai_agents/utils.py → libertai_agents/libertai_agents/utils.py b/libertai_agents/utils.py → libertai_agents/libertai_agents/utils.py
diff --git a/main.py → libertai_agents/main.py b/main.py → libertai_agents/main.py
diff --git a/mypy.ini → libertai_agents/mypy.ini b/mypy.ini → libertai_agents/mypy.ini
diff --git a/poetry.lock → libertai_agents/poetry.lock b/poetry.lock → libertai_agents/poetry.lock
diff --git a/pyproject.toml → libertai_agents/pyproject.toml b/pyproject.toml → libertai_agents/pyproject.toml