Skip to content

Commit

Permalink
Merge pull request #176 from kitsudaiki/tag-0.3.1
Browse files Browse the repository at this point in the history
updates for releasing 0.3.1
  • Loading branch information
kitsudaiki authored Sep 24, 2023
2 parents 0e365b8 + e0b85b8 commit 479272a
Show file tree
Hide file tree
Showing 370 changed files with 2,606 additions and 10,637 deletions.
8 changes: 0 additions & 8 deletions .github/workflows/build_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@ jobs:
run: |
chmod +x /build_result/libraries/hanami_common/tests/unit_tests/unit_tests
/build_result/libraries/hanami_common/tests/unit_tests/unit_tests
- name: "Run test: hanami_json"
run: |
chmod +x /build_result/libraries/hanami_json/tests/unit_tests/unit_tests
/build_result/libraries/hanami_json/tests/unit_tests/unit_tests
- name: "Run test: hanami_config"
run: |
chmod +x /build_result/libraries/hanami_config/tests/unit_tests/unit_tests
Expand Down Expand Up @@ -107,10 +103,6 @@ jobs:
run: |
chmod +x /build_result/libraries/hanami_common/tests/memory_leak_tests/memory_leak_tests
/build_result/libraries/hanami_common/tests/memory_leak_tests/memory_leak_tests
- name: "Run test: hanami_json"
run: |
chmod +x /build_result/libraries/hanami_json/tests/memory_leak_tests/memory_leak_tests
/build_result/libraries/hanami_json/tests/memory_leak_tests/memory_leak_tests
- name: "Run test: hanami_cluster_parser"
run: |
chmod +x /build_result/libraries/hanami_cluster_parser/tests/memory_leak_tests/memory_leak_tests
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
[submodule "src/frontend/Hanami-Dashboard-Dependencies"]
path = src/frontend/Hanami-Dashboard-Dependencies
url = https://github.com/kitsudaiki/Hanami-Dashboard-Dependencies.git
[submodule "src/third-party-libs/json"]
path = src/third-party-libs/json
url = https://github.com/nlohmann/json.git
21 changes: 20 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# Changelog

## ## v0.3.0
## v0.3.1

- **Date**: 2023-09-24

### Changed

- replaced json-parser by third-party library https://github.com/nlohmann/json
- updated internal registration of config-values
- updated internal registration of cli-arguments

### Fixed

- fixed bug in synapse-segmentation, which had impact in samller tests

### Removed

- Removed unused and deprecated checkpoint create and finalize endpoints


## v0.3.0

- **Date**: 2023-09-05

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,19 @@ https://docs.hanami-ai.com

- Installation-Guide to deploy HanamiAI on a kubernetes for testing:

[Installation on Kubernetes](https://docs.hanami-ai.com/How_To/1_installation/)
[Installation on Kubernetes](https://docs.hanami-ai.com/how_to/installation/)

- Automatic generated OpenAPI documentation

[OpenAPI docu](https://docs.hanami-ai.com/How_To/3_rest_api_documentation/)
[OpenAPI docu](https://docs.hanami-ai.com/api/rest_api_documentation/)

- To get a first impression there is a first example-workflow via the dashboard:

[Dashboard](https://docs.hanami-ai.com/How_To/2_dashboard/)
[Dashboard](https://docs.hanami-ai.com/how_to/dashboard/)

- Many basic dependencies were created in context of this project. Here is an overview of all involved repositories:

[Dependency-Overview](https://docs.hanami-ai.com/other/1_dependencies/)
[Dependency-Overview](https://docs.hanami-ai.com/other/dependencies/)



Expand Down
247 changes: 4 additions & 243 deletions docs/api/open_api_docu.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"contact": {
"email": "[email protected]",
"name": "Tobias Anker"
},
"info": {
"title": "API documentation",
"version": "unreleased"
Expand Down Expand Up @@ -407,249 +411,6 @@
"tags": [
"Checkpoint"
]
},
"post": {
"parameters": [
{
"description": "JWT-Token for authentication",
"in": "header",
"name": "X-Auth-Token",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"header": {
"description": "Header of the file with information of the splits.",
"type": "object"
},
"input_data_size": {
"description": "Total size of the checkpoint in number of bytes.",
"maximum": "10000000000",
"minimum": "1",
"type": "integer"
},
"name": {
"description": "Name of the new checkpoint.",
"maxLength": "256",
"minLength": "4",
"pattern": "[a-zA-Z][a-zA-Z_0-9 ]*",
"type": "string"
},
"project_id": {
"description": "ID of the project, where the checkpoint belongs to.",
"maxLength": "256",
"minLength": "4",
"pattern": "[a-zA-Z][a-zA-Z_0-9]*",
"type": "string"
},
"user_id": {
"description": "ID of the user, who owns the checkpoint.",
"maxLength": "256",
"minLength": "4",
"pattern": "[a-zA-Z][a-zA-Z_0-9@]*",
"type": "string"
},
"uuid": {
"description": "UUID of the new checkpoint.",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
}
},
"required": [
"header",
"input_data_size",
"name",
"project_id",
"user_id",
"uuid"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"description": "Name of the new checkpoint.",
"type": "string"
},
"uuid": {
"description": "UUID of the new checkpoint.",
"type": "string"
},
"uuid_input_file": {
"description": "UUID to identify the file for data upload of the checkpoint.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Successful response."
},
"400": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Request has invalid syntax."
},
"401": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Information for authentication are missing or are invalid"
},
"500": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Something internally went wrong. Check the server-internal logs for more information."
}
},
"summary": "Init new checkpoint of a cluster.",
"tags": [
"Checkpoint"
]
},
"put": {
"parameters": [
{
"description": "JWT-Token for authentication",
"in": "header",
"name": "X-Auth-Token",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"project_id": {
"description": "Name of the new set.",
"type": "string"
},
"user_id": {
"description": "ID of the user, who belongs to the checkpoint.",
"maxLength": "256",
"minLength": "4",
"pattern": "[a-zA-Z][a-zA-Z_0-9]*",
"type": "string"
},
"uuid": {
"description": "Name of the new set.",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
},
"uuid_input_file": {
"description": "UUID to identify the file for date upload of input-data.",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
"type": "string"
}
},
"required": [
"project_id",
"user_id",
"uuid",
"uuid_input_file"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"uuid": {
"description": "UUID of the new set.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Successful response."
},
"400": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Request has invalid syntax."
},
"401": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Information for authentication are missing or are invalid"
},
"404": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "The requested resource was not found."
},
"500": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Something internally went wrong. Check the server-internal logs for more information."
}
},
"summary": "Finish checkpoint of a cluster.",
"tags": [
"Checkpoint"
]
}
},
"v1/checkpoint/all": {
Expand Down
411 changes: 0 additions & 411 deletions docs/img/.$overview_dependencies.drawio.dtmp

This file was deleted.

4 changes: 2 additions & 2 deletions docs/img/overview_dependencies.drawio
Git LFS file not shown
9 changes: 8 additions & 1 deletion docs/other/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ Installed packages under the actual used Ubuntu 23.04

CUDA 12 is necessary, which is not in the standard apt-repositories below ubuntu 23.04. So in case it should be installed on 22.04, CUDA has to be installed manually with the manual: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html

### Submodules

| name | License | Purpose |
| --- | --- | --- |
| Thalhammer/jwt-cpp | MIT | create and validate jwt-token |
| nlohmann/json | MIT | json-parser |

### Runtime

| apt-package | Purpose |
Expand All @@ -51,6 +58,7 @@ I know, this is not a valid UML-diagram or something like this. It should old vi
| --- | --- |
| **Hanami** | Core of the Project |
| **Hanami-Dashboard** | Web-Client to directly interact with the Hanami-instance |
| **hanamictl** | CLI-Client to directly interact with the Hanami-instance |
| **SDK_API_Testing** | Functional tests for SDK-library and REST-API |
| **hanami_sdk** | SDK-library to provide functions for all supported actions to interact with the REST-API and automatic handling of the token-exchange. |
| **hanami_cluster_parser** | Parser-library for cluster-templates |
Expand All @@ -67,5 +75,4 @@ I know, this is not a valid UML-diagram or something like this. It should old vi
| **hanami_args** | Small and easy to use parser for CLI-arguments. |
| **hanami_ini** | Parser for the content of ini-files. |
| **hanami_crypto** | Wrapper-library for crypto-operation from other external libraries, to simplify the usage of basic operation like AES, HMAC, SHA256, etc. |
| **hanami_json** | Parser for the content of json-files. |
| **hanami_common** | Simple C++ library with commenly used functions for memory-handling, thread-handling, data representation and testing. |
Loading

0 comments on commit 479272a

Please sign in to comment.