Skip to content

Commit 36f82c7

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: 7 - JSON files created/updated: 8 - 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 e849169 commit 36f82c7

6 files changed

Lines changed: 44 additions & 31 deletions

File tree

‎.codeboarding/Hooks_Extensibility.json‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,12 @@
1717
"reference_start_line": 22,
1818
"reference_end_line": 79
1919
}
20-
],
21-
"assigned_files": [
22-
"src/friendli_core/_hooks/__init__.py",
23-
"src/friendli_core/_hooks/sdkhooks.py",
24-
"src/friendli_core/_hooks/registration.py",
25-
"src/friendli_core/_hooks/types.py"
26-
],
27-
"can_expand": true
20+
]
2821
},
2922
{
3023
"name": "Unclassified",
3124
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
32-
"referenced_source_code": [],
33-
"assigned_files": [],
34-
"can_expand": false
25+
"referenced_source_code": []
3526
}
3627
],
3728
"components_relations": [

‎.codeboarding/analysis.json‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414
],
1515
"assigned_files": [
1616
"src/friendli/friendli.py",
17-
"src/friendli/__init__.py",
18-
"src/friendli_core/sdk.py"
17+
"src/friendli/__init__.py"
1918
],
2019
"can_expand": true
2120
},
@@ -34,8 +33,6 @@
3433
"src/friendli/httpclient.py",
3534
"src/friendli/config.py",
3635
"src/friendli_core/__init__.py",
37-
"src/friendli_core/endpoint.py",
38-
"src/friendli_core/basesdk.py",
3936
"src/friendli_core/httpclient.py",
4037
"src/friendli_core/sdkconfiguration.py"
4138
],
@@ -72,30 +69,32 @@
7269
],
7370
"assigned_files": [
7471
"src/friendli/container/completions.py",
72+
"src/friendli/container/__init__.py",
7573
"src/friendli/container/chat.py",
7674
"src/friendli/container/token.py",
7775
"src/friendli/serverless/completions.py",
76+
"src/friendli/serverless/__init__.py",
7877
"src/friendli/serverless/chat.py",
7978
"src/friendli/serverless/tool_assisted_chat.py",
79+
"src/friendli/serverless/model.py",
8080
"src/friendli/serverless/token.py",
8181
"src/friendli/serverless/knowledge.py",
8282
"src/friendli/dedicated/completions.py",
83+
"src/friendli/dedicated/__init__.py",
8384
"src/friendli/dedicated/chat.py",
85+
"src/friendli/dedicated/endpoint.py",
8486
"src/friendli/dedicated/image.py",
8587
"src/friendli/dedicated/token.py",
8688
"src/friendli/dedicated/audio.py",
8789
"src/friendli/dataset/__init__.py",
8890
"src/friendli/dataset/dataset.py",
8991
"src/friendli/file/__init__.py",
9092
"src/friendli/file/file.py",
91-
"src/friendli_core/completions.py",
9293
"src/friendli_core/file.py",
93-
"src/friendli_core/chat.py",
94+
"src/friendli_core/container.py",
9495
"src/friendli_core/friendlicore_image.py",
9596
"src/friendli_core/friendlicore_completions.py",
96-
"src/friendli_core/image.py",
9797
"src/friendli_core/toolassistedchat.py",
98-
"src/friendli_core/dataset.py",
9998
"src/friendli_core/token.py",
10099
"src/friendli_core/friendlicore_token.py",
101100
"src/friendli_core/friendlicore_chat.py",
@@ -118,7 +117,6 @@
118117
"assigned_files": [
119118
"src/friendli/models.py",
120119
"src/friendli/types.py",
121-
"src/friendli/serverless/model.py",
122120
"src/friendli_core/model.py",
123121
"src/friendli_core/models/containerdetokenizationop.py",
124122
"src/friendli_core/models/splitinfo.py",
@@ -329,7 +327,9 @@
329327
"src/friendli_core/models/init_uploadop.py",
330328
"src/friendli_core/models/streamedchatdata.py",
331329
"src/friendli_core/models/fileinfo.py",
332-
"src/friendli_core/models/streamedcompletiondata.py"
330+
"src/friendli_core/models/streamedcompletiondata.py",
331+
"src/friendli_core/types/__init__.py",
332+
"src/friendli_core/types/basemodel.py"
333333
],
334334
"can_expand": true
335335
},
@@ -351,15 +351,9 @@
351351
}
352352
],
353353
"assigned_files": [
354-
"src/friendli/container/__init__.py",
355-
"src/friendli/serverless/__init__.py",
356-
"src/friendli/dedicated/__init__.py",
357-
"src/friendli/dedicated/endpoint.py",
358354
"src/friendli_core/friendlicore_serverless_chat.py",
359-
"src/friendli_core/dedicated.py",
360-
"src/friendli_core/container.py",
355+
"src/friendli_core/endpoint.py",
361356
"src/friendli_core/friendlicore_serverless_token.py",
362-
"src/friendli_core/serverless.py",
363357
"src/friendli_core/friendlicore_serverless_completions.py"
364358
],
365359
"can_expand": true
@@ -407,8 +401,6 @@
407401
"src/friendli_core/utils/unmarshal_json_response.py",
408402
"src/friendli_core/utils/eventstreaming.py",
409403
"src/friendli_core/utils/annotations.py",
410-
"src/friendli_core/types/__init__.py",
411-
"src/friendli_core/types/basemodel.py",
412404
"scripts/prepare_readme.py",
413405
"scripts/auto-fix.py"
414406
],
@@ -477,6 +469,13 @@
477469
"assigned_files": [],
478470
"can_expand": false
479471
},
472+
{
473+
"name": "Unclassified",
474+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
475+
"referenced_source_code": [],
476+
"assigned_files": [],
477+
"can_expand": false
478+
},
480479
{
481480
"name": "Unclassified",
482481
"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": "2fdc7274073734394c843c58e6c409cd8b275630",
2+
"commit_hash": "e84916952832b816d1b295902445036f49102019",
33
"code_boarding_version": "0.2.0"
44
}

‎.codeboarding/overview.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ graph LR
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2122
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2223
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -159,6 +160,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
159160
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
160161

161162

163+
**Related Classes/Methods**: _None_
164+
165+
### Unclassified
166+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
167+
168+
162169
**Related Classes/Methods**: _None_
163170

164171

‎docs/architecture/on_boarding.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,12 @@ _Last updated: 2025-11-22 20:33:01 UTC_
196196
- [overview.md](./overview.md)
197197

198198
_Last updated: 2025-11-29 20:36:48 UTC_
199+
- [Data_Models_Error_Handling.md](./Data_Models_Error_Handling.md)
200+
- [Friendli_Client_Public_API_.md](./Friendli_Client_Public_API_.md)
201+
- [Hooks_Extensibility.md](./Hooks_Extensibility.md)
202+
- [Platform_Abstractions.md](./Platform_Abstractions.md)
203+
- [SDK_Core.md](./SDK_Core.md)
204+
- [Service_Modules.md](./Service_Modules.md)
205+
- [overview.md](./overview.md)
206+
207+
_Last updated: 2025-12-06 20:34:16 UTC_

‎docs/architecture/overview.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ graph LR
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2122
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2223
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -159,6 +160,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
159160
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
160161

161162

163+
**Related Classes/Methods**: _None_
164+
165+
### Unclassified
166+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
167+
168+
162169
**Related Classes/Methods**: _None_
163170

164171

0 commit comments

Comments
 (0)