Data Folder

warning

🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.

When you install Cortex.cpp, three types of files will be generated on your device:

• Binary Files
• Configuration Files
• Data Folder

Binary Files

These are the executable files of the Cortex.cpp application. The file format varies depending on the operating system:

• Windows: .exe
  • Stable: C:\Users\<username>\AppData\Local\cortexcpp\cortex.exe
  • Beta: C:\Users\<username>\AppData\Local\cortexcpp-beta\cortex-beta.exe
  • Nighty: C:\Users\<username>\AppData\Local\cortexcpp-nightly\cortex-nightly.exe
• Linux: .deb or .fedora
  • Stable: /usr/bin/cortexcpp
  • Beta: /usr/bin/cortexcpp-beta
  • Nighty: /usr/bin/cortexcpp-nightly
• macOS: .pkg
  • Stable: /usr/local/bin/cortexcpp
  • Beta: /home/<username>/.cortexrc-beta
  • Nighty: /home/<username>/.cortexrc-nightly

Cortex.cpp Data Folder

The data folder stores the engines, models, and logs required by Cortex.cpp. This folder is located at:

• Windows:
  • Stable: C:\Users\<username>\.cortexcpp
  • Beta: C:\Users\<username>\.cortexcpp-beta
  • Nighty: C:\Users\<username>\.cortexcpp-nightly
• Linux:
  • Stable: /home/<username>/.cortexcpp<env>
  • Beta: /home/<username>/.cortexcpp-beta
  • Nighty: /home/<username>/.cortexcpp-nightly
• macOS:
  • Stable: /Users/<username>\.cortexcpp<env>
  • Beta: /Users/<username>/.cortexcpp-beta
  • Nighty: /Users/<username>/.cortexcpp-nightly

Folder Structure

The Cortex.cpp data folder typically follows this structure:

Stable

~/.cortex

├── models/

│ └── model.list

│ └── huggingface.co/

│ └── <repo_name>/

└── <branch_name>/

└── model.yaml

└── model.gguf

│ └── cortex.so/

│ └── <repo_name>/

│ └── <branch_name>/

└── ...engine_files

└── model.yaml

│ └── imported/

└── imported_model.yaml

├── logs/

│ └── cortex.txt

└── cortex-cli.txt

└── engines/

└── llamacpp

Beta

~/.cortex-beta

├── models/

│ └── model.list

│ └── huggingface.co/

│ └── <repo_name>/

└── <branch_name>/

└── model.yaml

└── model.gguf

│ └── cortex.so/

│ └── <repo_name>/

│ └── <branch_name>/

└── ...engine_files

└── model.yaml

│ └── imported/

└── imported_model.yaml

├── logs/

│ └── cortex.txt

└── cortex-cli.txt

└── engines/

└── llamacpp

Nightly

~/.cortex-nightly

├── models/

│ └── model.list

│ └── huggingface.co/

│ └── <repo_name>/

└── <branch_name>/

└── model.yaml

└── model.gguf

│ └── cortex.so/

│ └── <repo_name>/

│ └── <branch_name>/

└── ...engine_files

└── model.yaml

│ └── imported/

└── imported_model.yaml

├── logs/

│ └── cortex.txt

└── cortex-cli.txt

└── engines/

└── llamacpp

.cortexcpp<env>

The main directory that stores all Cortex-related files, located in the user's home directory.

models/

Contains the AI models used by Cortex for processing and generating responses.

info

For more information regarding the model.list and model.yaml, please see here.

logs/

Stores log files that are essential for troubleshooting and monitoring the performance of the Cortex.cpp API server and CLI.

We use Trantor for logging, which ensures non-blocking, thread-safe, multi-stream file logging without affecting system performance. Trantor automatically creates a new log file for each server session, based on the date and time, simplifying debugging. It also supports setting limits on log file size and the number of log files per session.

engines/

Stores the necessary dependencies and engine files needed to run Cortex on supported engines.