Skip to content

Commit 1def28d

Browse files
actions-useractions-user
committed
docs: update codeboarding architecture documentation
## 📚 Architecture Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service and copied to the architecture documentation section. ### 📊 Summary - Documentation files created/updated: 6 - JSON files created/updated: 7 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .md - Repository analyzed: https://github.com/CodeBoarding/friendli-python - Destination: docs/architecture/ The generated .md files have been automatically copied to the architecture documentation section and referenced in on_boarding.md. 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 6a93a3a commit 1def28d

File tree

7 files changed

+61
-191
lines changed

7 files changed

+61
-191
lines changed

‎.codeboarding/Hooks_Extensibility.json‎

Lines changed: 0 additions & 90 deletions
This file was deleted.

‎.codeboarding/Hooks_Extensibility.md‎

Lines changed: 0 additions & 66 deletions
This file was deleted.

‎.codeboarding/analysis.json‎

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
}
1414
],
1515
"assigned_files": [
16+
"/mnt/e/StartUp/friendli-python/src/friendli_core/sdk.py",
1617
"src/friendli/friendli.py",
17-
"src/friendli/__init__.py",
18-
"src/friendli_core/sdk.py"
18+
"src/friendli/__init__.py"
1919
],
2020
"can_expand": true
2121
},
@@ -31,12 +31,13 @@
3131
}
3232
],
3333
"assigned_files": [
34-
"src/friendli/httpclient.py",
35-
"src/friendli/config.py",
34+
"/mnt/e/StartUp/friendli-python/src/friendli_core/basesdk.py",
3635
"src/friendli_core/__init__.py",
37-
"src/friendli_core/basesdk.py",
3836
"src/friendli_core/httpclient.py",
39-
"src/friendli_core/sdkconfiguration.py"
37+
"src/friendli_core/sdkconfiguration.py",
38+
"src/friendli/httpclient.py",
39+
"src/friendli/config.py",
40+
"src/friendli_core/_version.py"
4041
],
4142
"can_expand": true
4243
},
@@ -70,25 +71,38 @@
7071
}
7172
],
7273
"assigned_files": [
74+
"/mnt/e/StartUp/friendli-python/src/friendli_core/chat.py",
75+
"/mnt/e/StartUp/friendli-python/src/friendli_core/completions.py",
76+
"/mnt/e/StartUp/friendli-python/src/friendli_core/dataset.py",
77+
"/mnt/e/StartUp/friendli-python/src/friendli_core/image.py",
7378
"src/friendli/container/completions.py",
7479
"src/friendli/container/__init__.py",
7580
"src/friendli/container/chat.py",
7681
"src/friendli/container/token.py",
82+
"src/friendli/serverless/completions.py",
83+
"src/friendli/serverless/chat.py",
84+
"src/friendli/serverless/tool_assisted_chat.py",
85+
"src/friendli/serverless/token.py",
86+
"src/friendli/serverless/knowledge.py",
87+
"src/friendli/dedicated/completions.py",
88+
"src/friendli/dedicated/chat.py",
89+
"src/friendli/dedicated/image.py",
90+
"src/friendli/dedicated/token.py",
91+
"src/friendli/dedicated/audio.py",
7792
"src/friendli/dataset/__init__.py",
7893
"src/friendli/dataset/dataset.py",
7994
"src/friendli/file/__init__.py",
8095
"src/friendli/file/file.py",
81-
"src/friendli_core/completions.py",
96+
"src/friendli_core/friendlicore_serverless_chat.py",
8297
"src/friendli_core/file.py",
8398
"src/friendli_core/container.py",
84-
"src/friendli_core/chat.py",
8599
"src/friendli_core/friendlicore_image.py",
86100
"src/friendli_core/friendlicore_completions.py",
87-
"src/friendli_core/image.py",
101+
"src/friendli_core/friendlicore_serverless_token.py",
88102
"src/friendli_core/toolassistedchat.py",
89-
"src/friendli_core/dataset.py",
90103
"src/friendli_core/token.py",
91104
"src/friendli_core/friendlicore_token.py",
105+
"src/friendli_core/friendlicore_serverless_completions.py",
92106
"src/friendli_core/friendlicore_chat.py",
93107
"src/friendli_core/knowledge.py",
94108
"src/friendli_core/audio.py"
@@ -109,7 +123,6 @@
109123
"assigned_files": [
110124
"src/friendli/models.py",
111125
"src/friendli/types.py",
112-
"src/friendli_core/model.py",
113126
"src/friendli_core/models/containerdetokenizationop.py",
114127
"src/friendli_core/models/splitinfo.py",
115128
"src/friendli_core/models/dedicatedgetendpointstatusop.py",
@@ -343,26 +356,13 @@
343356
}
344357
],
345358
"assigned_files": [
346-
"src/friendli/serverless/completions.py",
359+
"/mnt/e/StartUp/friendli-python/src/friendli_core/dedicated.py",
360+
"/mnt/e/StartUp/friendli-python/src/friendli_core/serverless.py",
361+
"src/friendli_core/endpoint.py",
347362
"src/friendli/serverless/__init__.py",
348-
"src/friendli/serverless/chat.py",
349-
"src/friendli/serverless/tool_assisted_chat.py",
350363
"src/friendli/serverless/model.py",
351-
"src/friendli/serverless/token.py",
352-
"src/friendli/serverless/knowledge.py",
353-
"src/friendli/dedicated/completions.py",
354364
"src/friendli/dedicated/__init__.py",
355-
"src/friendli/dedicated/chat.py",
356-
"src/friendli/dedicated/endpoint.py",
357-
"src/friendli/dedicated/image.py",
358-
"src/friendli/dedicated/token.py",
359-
"src/friendli/dedicated/audio.py",
360-
"src/friendli_core/friendlicore_serverless_chat.py",
361-
"src/friendli_core/dedicated.py",
362-
"src/friendli_core/endpoint.py",
363-
"src/friendli_core/friendlicore_serverless_token.py",
364-
"src/friendli_core/serverless.py",
365-
"src/friendli_core/friendlicore_serverless_completions.py"
365+
"src/friendli/dedicated/endpoint.py"
366366
],
367367
"can_expand": true
368368
},
@@ -383,15 +383,14 @@
383383
"src/friendli_core/_hooks/registration.py",
384384
"src/friendli_core/_hooks/types.py"
385385
],
386-
"can_expand": true
386+
"can_expand": false
387387
},
388388
{
389389
"name": "Unclassified",
390390
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
391391
"referenced_source_code": [],
392392
"assigned_files": [
393393
"src/friendli/utils.py",
394-
"src/friendli_core/_version.py",
395394
"src/friendli_core/utils/metadata.py",
396395
"src/friendli_core/utils/__init__.py",
397396
"src/friendli_core/utils/forms.py",
@@ -519,6 +518,13 @@
519518
"assigned_files": [],
520519
"can_expand": false
521520
},
521+
{
522+
"name": "Unclassified",
523+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
524+
"referenced_source_code": [],
525+
"assigned_files": [],
526+
"can_expand": false
527+
},
522528
{
523529
"name": "Unclassified",
524530
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",

‎.codeboarding/codeboarding_version.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "2ea1468f7385a75bb6be9fa534a1219fb6882458",
2+
"commit_hash": "6a93a3a37493a4fe3835b9f93030664d9f895966",
33
"code_boarding_version": "0.2.0"
44
}

‎.codeboarding/overview.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ graph LR
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
26+
Unclassified["Unclassified"]
2627
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2728
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2829
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -34,7 +35,6 @@ graph LR
3435
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
3536
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
3637
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
37-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
3838
```
3939

4040
[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/CodeBoarding)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/diagrams)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
@@ -92,7 +92,7 @@ Provides base structures and interfaces tailored for different operational modes
9292
- `friendli_core.serverless`
9393

9494

95-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
95+
### Hooks & Extensibility
9696
Offers an extensible mechanism for injecting custom logic at various stages of the request/response lifecycle, allowing for pre-processing, post-processing, and error handling customization.
9797

9898

@@ -201,6 +201,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
201201
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
202202

203203

204+
**Related Classes/Methods**: _None_
205+
206+
### Unclassified
207+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
208+
209+
204210
**Related Classes/Methods**: _None_
205211

206212

‎docs/architecture/on_boarding.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,3 +249,11 @@ _Last updated: 2026-01-03 20:39:50 UTC_
249249
- [overview.md](./overview.md)
250250

251251
_Last updated: 2026-01-10 20:36:29 UTC_
252+
- [Data_Models_Error_Handling.md](./Data_Models_Error_Handling.md)
253+
- [Friendli_Client_Public_API_.md](./Friendli_Client_Public_API_.md)
254+
- [Platform_Abstractions.md](./Platform_Abstractions.md)
255+
- [SDK_Core.md](./SDK_Core.md)
256+
- [Service_Modules.md](./Service_Modules.md)
257+
- [overview.md](./overview.md)
258+
259+
_Last updated: 2026-01-17 20:36:12 UTC_

‎docs/architecture/overview.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ graph LR
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
26+
Unclassified["Unclassified"]
2627
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2728
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2829
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -34,7 +35,6 @@ graph LR
3435
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
3536
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
3637
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
37-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
3838
```
3939

4040
[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/CodeBoarding)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/diagrams)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
@@ -92,7 +92,7 @@ Provides base structures and interfaces tailored for different operational modes
9292
- `friendli_core.serverless`
9393

9494

95-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
95+
### Hooks & Extensibility
9696
Offers an extensible mechanism for injecting custom logic at various stages of the request/response lifecycle, allowing for pre-processing, post-processing, and error handling customization.
9797

9898

@@ -201,6 +201,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
201201
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
202202

203203

204+
**Related Classes/Methods**: _None_
205+
206+
### Unclassified
207+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
208+
209+
204210
**Related Classes/Methods**: _None_
205211

206212

0 commit comments

Comments
 (0)