Project Structure
Project Folder Structure
The EleanorAI Framework is designed to be modular and flexible. The project folder structure is designed to be easy to navigate and understand. The following is a high-level overview of the project folder structure:
| Directory |
Description |
bin/ |
CLI scripts for managing the project. |
config/ |
Configuration files for the project. |
docker/ |
Dockerfile definitions for project containers. |
makefiles/ |
Makefiles used to manage various tasks used by the EleanorAI Framework |
mkdocs/ |
Source files for project documentation |
requirements/build/ |
Output of “compiled” Python requirements files. |
requirements/in/ |
Python requirements source files. See packaging. |
src/ |
Source code for the project. |
test/ |
Pytest code for the project. |
var/ |
Contains other various files used by the EleanorAI Framework. |
var/extern/ |
External codebase that are not considered part of the core EleanorAI Framework. |
var/prof/ |
Python process profiling output. |
var/runtime/ |
Runtime information for EleanorAI Framework processes and submodules |
var/submodules/ |
Submodules are external source code submodules that are considered optional dependencies used by the EleanorAI Framework. |
var/tmp/ |
Temporary files used by the EleanorAI Framework. |
Makefile Targets
This section contains a list of Makefile targets that can be used to manage the EleanorAI Framework. The Makefile targets are organized by category and are listed in alphabetical order.
Root Makefile Targets
| Target Name |
Description |
_container-down |
WIP |
_container-logs |
WIP |
_container-restart |
WIP |
_container-stop |
WIP |
_require_host_machine |
WIP |
default |
Default make target, executes pre-commit hooks |
eval |
Deprecated |
eval-dolphin |
Deprecated |
eval-dolphin-gptq |
Deprecated |
eval-gptq |
Deprecated |
eval-hellaswag-base |
Deprecated |
eval-list |
Deprecated |
eval-persona-base |
Deprecated |
eval-persona-base-gptq |
Deprecated |
eval-upload |
Deprecated |
jupyter |
Starts Jupyter notebook |
jupyter-research |
Starts Jupyter notebook in the research repository |
noop |
No operation |
pre_commit |
Execute project pre-commit hooks |
printvars |
Print environment variables in make environment |
targets |
Dynamically prints a list of Makefile targets |
ui |
Starts the EleanorAI Framework UI (Not implemented) |
Text Embedding Inference Targets
| Target Name |
Description |
_tei-up |
Deprecated |
tei-truck-down |
Deprecated |
tei-truck-logs |
Deprecated |
tei-truck-redeploy |
Deprecated |
tei-truck-restart |
Deprecated |
tei-truck-start |
Deprecated |
tei-truck-stop |
Deprecated |
tei-truck-up |
Deprecated |
tei-wm-down |
WIP |
tei-wm-logs |
WIP |
tei-wm-redeploy |
WIP |
tei-wm-restart |
WIP |
tei-wm-start |
WIP |
tei-wm-stop |
WIP |
tei-wm-up |
WIP |
Text Generation Inference Targets
| Target Name |
Description |
_tgi-up |
WIP |
tgi-build |
WIP |
tgi-init |
WIP |
tgi-truck-down |
WIP |
tgi-truck-start |
WIP |
tgi-truck-stop |
WIP |
tgi-truck-up |
WIP |
tgi-wm-down |
WIP |
tgi-wm-start |
WIP |
tgi-wm-stop |
WIP |
tgi-wm-up |
WIP |
Alltalk Targets
| Target Name |
Description |
_alltalk-up |
WIP |
alltalk-build |
WIP |
alltalk-down |
WIP |
alltalk-push |
WIP |
alltalk-start |
WIP |
alltalk-stop |
WIP |
alltalk-up |
WIP |
Aphrodite Engine Targets
| Target Name |
Description |
_aphrodite-main-c4ai-command-r-plus-4bit-up |
Deprecated |
_aphrodite-main-c4ai-command-r-plus-GPTQ-up |
Deprecated |
_aphrodite-main-c4ai-command-r-plus-up |
Deprecated |
_aphrodite-main-llama3-70b-Instruct-GPTQ-up |
Deprecated |
_aphrodite-main-llama3-70b-instruct-up |
Deprecated |
_aphrodite-main-llama3-8b-instruct-up |
Deprecated |
_aphrodite-main-miqu-1-70b-sf-up |
Deprecated |
_aphrodite-up |
Deprecated |
aphrodite-build |
Deprecated |
aphrodite-help |
Deprecated |
aphrodite-main-cli |
Deprecated |
aphrodite-main-down |
Deprecated |
aphrodite-main-logs |
Deprecated |
aphrodite-main-restart |
Deprecated |
aphrodite-main-start |
Deprecated |
aphrodite-main-stop |
Deprecated |
aphrodite-main-up |
Deprecated |
aphrodite-push |
Deprecated |
API Client Targets
| Target Name |
Description |
api-client |
WIP |
api-run |
WIP |
Backend Targets
| Target Name |
Description |
_backend-adminui-up |
WIP |
_backend-api-up |
WIP |
_backend-jobs-up |
WIP |
backend-adminui-down |
WIP |
backend-adminui-logs |
WIP |
backend-adminui-restart |
WIP |
backend-adminui-start |
WIP |
backend-adminui-stop |
WIP |
backend-adminui-up |
WIP |
backend-api-down |
WIP |
backend-api-logs |
WIP |
backend-api-restart |
WIP |
backend-api-start |
WIP |
backend-api-stop |
WIP |
backend-api-up |
WIP |
backend-jobs-down |
WIP |
backend-jobs-logs |
WIP |
backend-jobs-restart |
WIP |
backend-jobs-start |
WIP |
backend-jobs-stop |
WIP |
backend-jobs-up |
WIP |
backend-redeploy |
WIP |
Container Targets
| Target Name |
Description |
build-containers |
WIP |
containers |
WIP |
docker-build-dev |
WIP |
docker-build-eval |
WIP |
docker-build-runtime |
WIP |
docker-push-dev |
WIP |
tag-working |
WIP |
LiteLLM Targets
| Target Name |
Description |
_litellm-up |
WIP |
litellm-down |
WIP |
litellm-exec |
WIP |
litellm-logs |
WIP |
litellm-pull |
WIP |
litellm-start |
WIP |
litellm-stop |
WIP |
litellm-up |
WIP |
MKDocs Targets
| Target Name |
Description |
_mkdocs-images-clean |
WIP |
_mkdocs-images-init |
WIP |
_mkdocs-images-step1 |
WIP |
_mkdocs-images-step2 |
WIP |
_mkdocs-images-step3 |
WIP |
_mkdocs-images-step4 |
WIP |
_mkdocs-images-step5 |
WIP |
_mkdocs-images-step6 |
WIP |
_mkdocs-stage |
WIP |
mkdocs-build |
WIP |
mkdocs-clean |
WIP |
mkdocs-images |
WIP |
mkdocs-publish |
WIP |
mkdocs-serve |
WIP |
mkdocs-serve-full |
WIP |
Ollama Targets
| Target Name |
Description |
_ollama-up |
WIP |
ollama-down |
WIP |
ollama-exec |
WIP |
ollama-logs |
WIP |
ollama-pull |
WIP |
ollama-setup |
WIP |
ollama-start |
WIP |
ollama-stop |
WIP |
ollama-up |
WIP |
OpenDevin Targets
| Target Name |
Description |
_opendevin-up |
WIP |
opendevin-down |
WIP |
opendevin-exec |
WIP |
opendevin-logs |
WIP |
opendevin-start |
WIP |
opendevin-stop |
WIP |
opendevin-up |
WIP |
opendevin_pull |
WIP |
Packaging Targets
| Target Name |
Description |
pkg-build |
WIP |
pkg-req-compile |
WIP |
requirements |
WIP |
Project Targets
| Target Name |
Description |
project-init |
WIP |
project-venv |
WIP |
RDBMS Targets
| Target Name |
Description |
rdbms-revision |
WIP |
rdbms-upgrade |
WIP |
SillyTavern Targets
| Target Name |
Description |
_st-extras-up |
WIP |
_st-up |
WIP |
st-down |
WIP |
st-extras-build |
WIP |
st-extras-down |
WIP |
st-extras-start |
WIP |
st-extras-stop |
WIP |
st-extras-up |
WIP |
st-start |
WIP |
st-stop |
WIP |
st-up |
WIP |
Fine-Tuning Targets
| Target Name |
Description |
_gptq-up |
WIP |
_merge |
WIP |
_train |
WIP |
clean |
WIP |
gpu-tools-start |
WIP |
gpu-tools-stop |
WIP |
preprocess |
WIP |
train |
WIP |
vLLM Targets
| Target Name |
Description |
_vllm-up |
WIP |
vllm-cli |
WIP |
vllm-down |
WIP |
vllm-help |
WIP |
vllm-inspect |
WIP |
vllm-logs |
WIP |
vllm-pull |
WIP |
vllm-restart |
WIP |
vllm-start |
WIP |
vllm-stop |
WIP |
vllm-up |
WIP |
XTTS Targets
| Target Name |
Description |
_xtts-up |
WIP |
xtts-build |
WIP |
xtts-down |
WIP |
xtts-push |
WIP |
xtts-start |
WIP |
xtts-stop |
WIP |
xtts-up |
WIP |