Skip to content

Commit cff44b5

Browse files
JavadIntegerJavadInteger
committed
Added Config files and Documentions (v1.2)
1 parent 98bb73c commit cff44b5

25 files changed

Lines changed: 496 additions & 0 deletions

‎config/config.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"topK": 5,
3+
"embeddingSize": 16,
4+
"rewardFactor": 1.2,
5+
"decayFactor": 0.95
6+
}

‎config/engine.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"topK": 5,
3+
"rewardFactor": 1.2,
4+
"decayFactor": 0.95,
5+
"cache": {
6+
"enabled": true,
7+
"maxEntries": 1024
8+
},
9+
"index": {
10+
"segmentSize": 1024,
11+
"path": "data/index.aix"
12+
},
13+
"optimizer": {
14+
"enabled": true,
15+
"profilePath": "data/query-profiles.json",
16+
"minSamples": 5
17+
}
18+
}

‎config/gpu.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"backend": "none",
3+
"dimension": 384,
4+
"maxdocsper_batch": 8192
5+
}

‎config/llm.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"provider": "llm",
3+
"model": "atoqu-llm-embeddings-v0.9",
4+
"dimension": 384,
5+
"scale": 1.0
6+
}

‎config/modes.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[
2+
{ "name": "NormalMode", "enabled": true, "weight": 1.0 },
3+
{ "name": "HybridMode", "enabled": true, "weight": 1.0 },
4+
{ "name": "LiteralMode", "enabled": true, "weight": 0.8 },
5+
{ "name": "VectorMode", "enabled": true, "weight": 0.8 },
6+
{ "name": "BM25Mode", "enabled": true, "weight": 0.9 },
7+
{ "name": "RecencyMode", "enabled": false, "weight": 0.5 },
8+
{ "name": "TagBoostMode", "enabled": false, "weight": 0.5 }
9+
]

‎config/weights.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"modeWeights": [1.0, 1.0, 1.0]
3+
}

‎docs/CMakeLists.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
if (ATOQUBUILDDOCS)
2+
add_subdirectory(doxygen)
3+
add_subdirectory(sphinx)
4+
endif()

‎docs/architecture.html‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Atoqu — Architecture</title>
6+
<link rel="stylesheet" href="css/style.css">
7+
</head>
8+
<body>
9+
<header>
10+
<h1>Architecture</h1>
11+
<p>Atomic + Quantum-inspired engine design</p>
12+
</header>
13+
14+
<main>
15+
<section>
16+
<h2>Core</h2>
17+
<p><code>AtoquEngine</code> orchestrates modes, optimizer, and indexer.</p>
18+
</section>
19+
20+
<section>
21+
<h2>Modes</h2>
22+
<p>Literal, Vector, Hybrid — each as an independent search strategy.</p>
23+
</section>
24+
25+
<section>
26+
<h2>Optimizer</h2>
27+
<p>Learns query patterns and adjusts mode weights per query.</p>
28+
</section>
29+
30+
<section>
31+
<h2>Utils</h2>
32+
<p>Custom JSON, logging, filesystem, time, and networking utilities.</p>
33+
</section>
34+
</main>
35+
36+
<footer>
37+
<p>Atoqu Engine Documentation</p>
38+
</footer>
39+
</body>
40+
</html>

‎docs/cli.html‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Atoqu — CLI Usage</title>
6+
<link rel="stylesheet" href="css/style.css">
7+
</head>
8+
<body>
9+
<header>
10+
<h1>CLI Usage</h1>
11+
<p>Interact with Atoqu from the terminal</p>
12+
</header>
13+
14+
<main>
15+
<section>
16+
<h2>Start CLI</h2>
17+
<pre><code>./atoqu</code></pre>
18+
</section>
19+
20+
<section>
21+
<h2>Enter Queries</h2>
22+
<p>Type a query and press Enter to see ranked results.</p>
23+
</section>
24+
25+
<section>
26+
<h2>Inspect Mode Weights</h2>
27+
<pre><code>:stats</code></pre>
28+
<p>Shows current mode weights after feedback and optimizer adjustments.</p>
29+
</section>
30+
</main>
31+
32+
<footer>
33+
<p>Atoqu Engine Documentation</p>
34+
</footer>
35+
</body>
36+
</html>

‎docs/config.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Atoqu — Configuration</title>
6+
<link rel="stylesheet" href="css/style.css">
7+
</head>
8+
<body>
9+
<header>
10+
<h1>Configuration</h1>
11+
<p>Control Atoqu behavior via JSON configs</p>
12+
</header>
13+
14+
<main>
15+
<section>
16+
<h2>Modes</h2>
17+
<p><code>config/modes.json</code> controls which modes are enabled and their initial weights.</p>
18+
</section>
19+
20+
<section>
21+
<h2>Engine</h2>
22+
<p><code>config/engine.json</code> controls reward/decay factors and optimizer/index settings.</p>
23+
</section>
24+
25+
<section>
26+
<h2>LLM</h2>
27+
<p><code>config/llm.json</code> selects embedding provider and embedding size.</p>
28+
</section>
29+
</main>
30+
31+
<footer>
32+
<p>Atoqu Engine Documentation</p>
33+
</footer>
34+
</body>
35+
</html>

0 commit comments

Comments
 (0)