Skip to content

Commit ee72b63

Browse files
kitsudaikikitsudaiki
committed
docs(#779): fix and update readme and roadmap
Signed-off-by: Tobias Anker <tobias.anker@kitsunemimi.moe>
1 parent 34a1deb commit ee72b63

4 files changed

Lines changed: 183 additions & 36 deletions

File tree

‎.secrets.baseline‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -355,33 +355,40 @@
355355
"is_verified": false,
356356
"line_number": 23
357357
},
358+
{
359+
"type": "Base64 High Entropy String",
360+
"filename": "docs/user/rest_api/open_api_docu_hanami.json",
361+
"hashed_secret": "dd2186dc208fcff4599e1cceb7d862812a41f949",
362+
"is_verified": false,
363+
"line_number": 193
364+
},
358365
{
359366
"type": "Base64 High Entropy String",
360367
"filename": "docs/user/rest_api/open_api_docu_hanami.json",
361368
"hashed_secret": "fd178ee231766245d59ac6a33c4540b4fbf10c44",
362369
"is_verified": false,
363-
"line_number": 179
370+
"line_number": 233
364371
},
365372
{
366373
"type": "Base64 High Entropy String",
367374
"filename": "docs/user/rest_api/open_api_docu_hanami.json",
368375
"hashed_secret": "b06dc8879602f0b779b37dc786381fe605b241ad",
369376
"is_verified": false,
370-
"line_number": 229
377+
"line_number": 283
371378
},
372379
{
373380
"type": "Base64 High Entropy String",
374381
"filename": "docs/user/rest_api/open_api_docu_hanami.json",
375382
"hashed_secret": "c2e6d60037d140dfb624ab9ef56dcf13ef335e28",
376383
"is_verified": false,
377-
"line_number": 274
384+
"line_number": 328
378385
},
379386
{
380387
"type": "Base64 High Entropy String",
381388
"filename": "docs/user/rest_api/open_api_docu_hanami.json",
382389
"hashed_secret": "a89b72daf2cf431259335a998708b8d1698d436e",
383390
"is_verified": false,
384-
"line_number": 355
391+
"line_number": 409
385392
}
386393
],
387394
"docs/user/rest_api/open_api_docu_miko.json": [
@@ -478,28 +485,35 @@
478485
"filename": "docs/user/rest_api/open_api_docu_ryokan.json",
479486
"hashed_secret": "a0b64da55d6ba24ad34554fd5ac666709d648476",
480487
"is_verified": false,
481-
"line_number": 510
488+
"line_number": 552
489+
},
490+
{
491+
"type": "Base64 High Entropy String",
492+
"filename": "docs/user/rest_api/open_api_docu_ryokan.json",
493+
"hashed_secret": "c505379e012f9000d75ad3768074f9eb30ceeb87",
494+
"is_verified": false,
495+
"line_number": 645
482496
},
483497
{
484498
"type": "Base64 High Entropy String",
485499
"filename": "docs/user/rest_api/open_api_docu_ryokan.json",
486500
"hashed_secret": "f000819e8b01002c73af6e6f6ce52219d9a2b9e5",
487501
"is_verified": false,
488-
"line_number": 732
502+
"line_number": 814
489503
},
490504
{
491505
"type": "Base64 High Entropy String",
492506
"filename": "docs/user/rest_api/open_api_docu_ryokan.json",
493507
"hashed_secret": "c2e6d60037d140dfb624ab9ef56dcf13ef335e28",
494508
"is_verified": false,
495-
"line_number": 784
509+
"line_number": 866
496510
},
497511
{
498512
"type": "Base64 High Entropy String",
499513
"filename": "docs/user/rest_api/open_api_docu_ryokan.json",
500514
"hashed_secret": "a89b72daf2cf431259335a998708b8d1698d436e",
501515
"is_verified": false,
502-
"line_number": 865
516+
"line_number": 947
503517
}
504518
],
505519
"docs/user/rest_api/open_api_docu_sakura.json": [
@@ -515,14 +529,14 @@
515529
"filename": "docs/user/rest_api/open_api_docu_sakura.json",
516530
"hashed_secret": "96d225a15ce061f99413f12fce8d3cbd0fad814e",
517531
"is_verified": false,
518-
"line_number": 391
532+
"line_number": 405
519533
},
520534
{
521535
"type": "Base64 High Entropy String",
522536
"filename": "docs/user/rest_api/open_api_docu_sakura.json",
523537
"hashed_secret": "24e7ae3b409849e1448ed764dee7b906c89425a7",
524538
"is_verified": false,
525-
"line_number": 641
539+
"line_number": 655
526540
}
527541
],
528542
"docs/user/rest_api/open_api_docu_torii.json": [
@@ -590,5 +604,5 @@
590604
}
591605
]
592606
},
593-
"generated_at": "2025-12-20T16:50:59Z"
607+
"generated_at": "2025-12-20T19:40:52Z"
594608
}

‎README.md‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,13 @@ Ainari is split into a micro-service architecture. See here for
161161
162162
- [SDK and CLI documentation](https://docs.ainari.cloud/user/cli_sdk/cli_sdk_docu/)
163163
164-
- [Automatic generated OpenAPI documentation](https://docs.ainari.cloud/frontend/rest_api_documentation/)
164+
- [Automatic generated OpenAPI documentation](https://docs.ainari.cloud/user/rest_api/rest_api_docu_sakura/)
165165
166166
## Development
167167
168168
- [How to build](https://docs.ainari.cloud/developer/repo/build_guide/)
169169
170-
- [Development-Guide](https://docs.ainari.cloud/repo/development/)
170+
- [Development-Guide](https://docs.ainari.cloud/developer/repo/development/)
171171
172172
- [Dependency-Overview](https://docs.ainari.cloud/developer/repo/dependencies/)
173173
@@ -186,11 +186,6 @@ on `develop`-branch and for each tag.
186186
There are some features, which existed in the past, were disabled temporary and will be
187187
added/enabled again in the near future:
188188
189-
1. Dashboard
190-
191-
As a PoC a first dashboard was created, without any framework. At the moment it is in process of
192-
refactoring and re-implementation in Vue.js and Typescript.
193-
194189
1. Regulation of CPU-speed
195190
196191
Also in older version there also was the function available to regulate the speed of the CPU

‎ROADMAP.md‎

Lines changed: 156 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,159 @@
22

33
The roadmap is only a current expectation and will be updated and changed, if necessary.
44

5-
| Version | Release-Date | Main-Tasks | Release-Notes |
6-
| ----------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| **v0.1.0** | 18.10.2022 | <p> - initial PoC Feature-set of the new as-a-service setup <p> - project split into 36 repositories | <p> [v0.1.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v010) |
8-
| **v0.2.0** | 15.03.2023 | <p> merged all repositories into this one here to reduce the maintenace workload <p> - improved creation of cluster and tasks <p> - use protobuf to send payload | <p> [v0.2.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v020) |
9-
| **v0.3.0** | 05.09.2023 | <p> - removded entire microservice-architecture again, because it produces too much unnecessary complexety <p> - big internal restructuring of the core | <p> [v0.3.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v030) <p> [v0.3.1](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v031) <p> [v0.3.2](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v032) |
10-
| **v0.4.0** | 21.01.2024 | <p> - big internal restructuring of the core <p> - provide multi-threading for the core for more performance <p> - added python-SDK and more endpoints | <p> [v0.4.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v040) <p> [v0.4.1](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v041) |
11-
| **v0.5.0** | 11.08.2024 | <p> - big internal restructuring of the core <p> - auto-scaling of internal neurons <p> - massive upgrade of the CI-pipline <p> - streaming of datasets in and out of the cluster while processing | <p> [v0.5.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v050) |
12-
| **v0.6.0** | 14.12.2024 | <p> - auto-scaling of inputs and outputs based on the given data | <p> [v0.6.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v060) |
13-
| **v0.7.0** | 19.03.2025 | <p> - big core-update | <p> [v0.7.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v070) |
14-
| **v0.8.0** | 10.06.2025 | <p> - refactor API and DB-connection from C++ code into Rust | <p> [v0.8.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v080) |
15-
| **v0.9.0** | 24.08.2025 | <p> - refactoring of the rest of the C++ code into Rust | <p> [v0.9.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v090) |
16-
| **v0.10.0** | Q4/2025 | <p> - new micro-service architecture <p> - new dashboard | - |
17-
| **v0.11.0** | Q1/2026 | <p> - Multi-Node-Setup <p> - provide migration of cluster between nodes | - |
5+
## v0.1.0
6+
7+
**Release-Date:** 18.10.2022
8+
9+
**Main-Tasks:**
10+
- initial PoC Feature-set of the new as-a-service setup
11+
- project split into 36 repositories
12+
13+
**Release-Notes:**
14+
- [v0.1.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v010)
15+
16+
## v0.2.0
17+
18+
**Release-Date:** 15.03.2023
19+
20+
**Main-Tasks:**
21+
- merged all repositories into this one here to reduce the maintenace workload
22+
- improved creation of cluster and tasks
23+
- use protobuf to send payload
24+
25+
**Release-Notes:**
26+
- [v0.2.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v020)
27+
28+
## v0.3.0
29+
30+
**Release-Date:** 05.09.2023
31+
32+
**Main-Tasks:**
33+
- removed entire microservice-architecture again, because it produces too much unnecessary complexety
34+
- big internal restructuring of the core
35+
36+
**Release-Notes:**
37+
- [v0.3.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v030)
38+
- [v0.3.1](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v031)
39+
- [v0.3.2](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v032)
40+
41+
## v0.4.0
42+
43+
**Release-Date:** 21.01.2024
44+
45+
**Main-Tasks:**
46+
- big internal restructuring of the core
47+
- provide multi-threading for the core for more performance
48+
- added python-SDK and more endpoints
49+
50+
**Release-Notes:**
51+
- [v0.4.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v040)
52+
- [v0.4.1](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v041)
53+
54+
## v0.5.0
55+
56+
**Release-Date:** 11.08.2024
57+
58+
**Main-Tasks:**
59+
- big internal restructuring of the core
60+
- auto-scaling of internal neurons
61+
- massive upgrade of the CI-pipline
62+
- streaming of datasets in and out of the cluster while processing
63+
64+
**Release-Notes:**
65+
- [v0.5.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v050)
66+
67+
## v0.6.0
68+
69+
**Release-Date:** 14.12.2024
70+
71+
**Main-Tasks:**
72+
- auto-scaling of inputs and outputs based on the given data
73+
74+
**Release-Notes:**
75+
- [v0.6.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v060)
76+
77+
## v0.7.0
78+
79+
**Release-Date:** 19.03.2025
80+
81+
**Main-Tasks:**
82+
- big core-update
83+
84+
**Release-Notes:**
85+
- [v0.7.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v070)
86+
87+
## v0.8.0
88+
89+
**Release-Date:** 10.06.2025
90+
91+
**Main-Tasks:**
92+
- refactor API and DB-connection from C++ code into Rust
93+
94+
**Release-Notes:**
95+
- [v0.8.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v080)
96+
97+
## v0.9.0
98+
99+
**Release-Date:** 24.08.2025
100+
101+
**Main-Tasks:**
102+
- refactoring of the rest of the C++ code into Rust
103+
104+
**Release-Notes:**
105+
- [v0.9.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v090)
106+
- [v0.9.1](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v091)
107+
108+
## v0.10.0
109+
110+
**Release-Date:** 20.12.2015
111+
112+
**Main-Tasks:**
113+
- new micro-service architecture
114+
- new dashboard
115+
116+
**Release-Notes:**
117+
- [v0.10.0](https://github.com/kitsudaiki/ainari/blob/develop/CHANGELOG.md#v0100)
118+
119+
## v0.11.0
120+
121+
**Release-Date:** Q1/2026
122+
123+
**Main-Tasks:**
124+
- Redundant api with real database
125+
- multiple Sakura- and Onsen-instances (without migration)
126+
- basic Monitoring
127+
128+
**Release-Notes:**
129+
-
130+
131+
## v0.12.0
132+
133+
**Release-Date:** Q2/2026
134+
135+
**Main-Tasks:**
136+
- Improvements and evaluation for the core
137+
138+
**Release-Notes:**
139+
-
140+
141+
## v0.13.0
142+
143+
**Release-Date:** Q3/2026
144+
145+
**Main-Tasks:**
146+
- Workload and storage migration
147+
- Backups
148+
149+
**Release-Notes:**
150+
-
151+
152+
## v0.14.0
153+
154+
**Release-Date:** Q4/2026
155+
156+
**Main-Tasks:**
157+
- new GPU-support
158+
159+
**Release-Notes:**
160+
-

‎docs/index.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,11 +185,6 @@ Ainari is split into a micro-service architecture. See here for
185185
There are some features, which existed in the past, were disabled temporary and will be
186186
added/enabled again in the near future:
187187

188-
1. Dashboard
189-
190-
As a PoC a first dashboard was created, without any framework. At the moment it is in process of
191-
refactoring and re-implementation in Vue.js and Typescript.
192-
193188
1. Regulation of CPU-speed
194189

195190
Also in older version there also was the function available to regulate the speed of the CPU

0 commit comments

Comments
 (0)