From 881735043e98d707523513973b4b8f72e018d17c Mon Sep 17 00:00:00 2001 From: vansangpfiev Date: Mon, 4 Nov 2024 11:16:57 +0700 Subject: [PATCH 1/3] chore: cortexrc docs update --- docs/docs/architecture/cortexrc.mdx | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/docs/architecture/cortexrc.mdx b/docs/docs/architecture/cortexrc.mdx index 312d77986..cac4dedd0 100644 --- a/docs/docs/architecture/cortexrc.mdx +++ b/docs/docs/architecture/cortexrc.mdx @@ -34,12 +34,27 @@ You can configure the following parameters in the `.cortexrc` file: | Parameter | Description | Default Value | |------------------|--------------------------------------------------|--------------------------------| | `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. | -| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` | -| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` | +| `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` | +| `logFolderPath` | Port number for the Cortex.cpp API server. | `39281` | +| `logLlamaCppPath` | The llama-cpp engine . | `./logs/cortex.log` | +| `logTensorrtLLMPath` | The tensorrt-llm engine log file path. | `./logs/cortex.log` | +| `logOnnxPath` | The onnxruntime engine log file path. | `./logs/cortex.log` | +| `maxLogLines` | The maximum log lines that write to file. | `100000` | +| `checkedForUpdateAt` | The last time for checking updates. | `` | +| `latestRelease` | The lastest release vesion. | `` | +| `huggingFaceToken` | HuggingFace token. | `` | Example of the `.cortexrc` file: ``` +logFolderPath: /Users//cortexcpp +logLlamaCppPath: ./logs/cortex.log +logTensorrtLLMPath: ./logs/cortex.log +logOnnxPath: ./logs/cortex.log dataFolderPath: /Users//cortexcpp +maxLogLines: 100000 apiServerHost: 127.0.0.1 apiServerPort: 39281 +checkedForUpdateAt: 1730501224 +latestRelease: v1.0.1 +huggingFaceToken: "" ``` \ No newline at end of file From 7f0d04fe5ed55d39a1fb0e11890d390b617d8209 Mon Sep 17 00:00:00 2001 From: vansangpfiev Date: Mon, 4 Nov 2024 11:26:14 +0700 Subject: [PATCH 2/3] chore: default value --- docs/docs/architecture/cortexrc.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/architecture/cortexrc.mdx b/docs/docs/architecture/cortexrc.mdx index cac4dedd0..2b57254fd 100644 --- a/docs/docs/architecture/cortexrc.mdx +++ b/docs/docs/architecture/cortexrc.mdx @@ -40,9 +40,9 @@ You can configure the following parameters in the `.cortexrc` file: | `logTensorrtLLMPath` | The tensorrt-llm engine log file path. | `./logs/cortex.log` | | `logOnnxPath` | The onnxruntime engine log file path. | `./logs/cortex.log` | | `maxLogLines` | The maximum log lines that write to file. | `100000` | -| `checkedForUpdateAt` | The last time for checking updates. | `` | -| `latestRelease` | The lastest release vesion. | `` | -| `huggingFaceToken` | HuggingFace token. | `` | +| `checkedForUpdateAt` | The last time for checking updates. | `0` | +| `latestRelease` | The lastest release vesion. | Empty string | +| `huggingFaceToken` | HuggingFace token. | Empty string | Example of the `.cortexrc` file: ``` From 64bf37d3d13286f6f5d25958b021c643353f7a35 Mon Sep 17 00:00:00 2001 From: vansangpfiev Date: Mon, 4 Nov 2024 14:47:17 +0700 Subject: [PATCH 3/3] chore: comments --- docs/docs/architecture/cortexrc.mdx | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/docs/architecture/cortexrc.mdx b/docs/docs/architecture/cortexrc.mdx index 2b57254fd..24dc63a2d 100644 --- a/docs/docs/architecture/cortexrc.mdx +++ b/docs/docs/architecture/cortexrc.mdx @@ -16,18 +16,9 @@ Cortex.cpp supports reading its configuration from a file called `.cortexrc`. Us ## File Location The configuration file is stored in the following locations: -- **Windows**: - - Stable: `C:\Users\\.cortexrc` - - Beta: `C:\Users\\.cortexrc-beta` - - Nighty: `C:\Users\\.cortexrc-nightly` -- **Linux**: - - Stable: `/home//.cortexrc` - - Beta: `/home//.cortexrc-beta` - - Nighty: `/home//.cortexrc-nightly` -- **macOS**: - - Stable: `/Users//.cortexrc` - - Beta: `/Users//.cortexrc-beta` - - Nighty: `/Users//.cortexrc-nightly` +- **Windows**: `C:\Users\\.cortexrc` +- **Linux**: `/home//.cortexrc` +- **macOS**: `/Users//.cortexrc` ## Configuration Parameters You can configure the following parameters in the `.cortexrc` file: @@ -35,7 +26,8 @@ You can configure the following parameters in the `.cortexrc` file: |------------------|--------------------------------------------------|--------------------------------| | `dataFolderPath` | Path to the folder where `.cortexrc` located. | User's home folder. | | `apiServerHost` | Host address for the Cortex.cpp API server. | `127.0.0.1` | -| `logFolderPath` | Port number for the Cortex.cpp API server. | `39281` | +| `apiServerPort` | Port number for the Cortex.cpp API server. | `39281` | +| `logFolderPath` | Path the folder where logs are located | User's home folder. | | `logLlamaCppPath` | The llama-cpp engine . | `./logs/cortex.log` | | `logTensorrtLLMPath` | The tensorrt-llm engine log file path. | `./logs/cortex.log` | | `logOnnxPath` | The onnxruntime engine log file path. | `./logs/cortex.log` |