Skip to content

Commit 5687f0d

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 1def28d commit 5687f0d

File tree

5 files changed

+60
-30
lines changed

5 files changed

+60
-30
lines changed

‎.codeboarding/analysis.json‎

Lines changed: 37 additions & 29 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",
1716
"src/friendli/friendli.py",
18-
"src/friendli/__init__.py"
17+
"src/friendli/__init__.py",
18+
"src/friendli_core/sdk.py"
1919
],
2020
"can_expand": true
2121
},
@@ -31,13 +31,13 @@
3131
}
3232
],
3333
"assigned_files": [
34-
"/mnt/e/StartUp/friendli-python/src/friendli_core/basesdk.py",
35-
"src/friendli_core/__init__.py",
36-
"src/friendli_core/httpclient.py",
37-
"src/friendli_core/sdkconfiguration.py",
3834
"src/friendli/httpclient.py",
3935
"src/friendli/config.py",
40-
"src/friendli_core/_version.py"
36+
"src/friendli_core/__init__.py",
37+
"src/friendli_core/endpoint.py",
38+
"src/friendli_core/basesdk.py",
39+
"src/friendli_core/httpclient.py",
40+
"src/friendli_core/sdkconfiguration.py"
4141
],
4242
"can_expand": true
4343
},
@@ -71,38 +71,25 @@
7171
}
7272
],
7373
"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",
7874
"src/friendli/container/completions.py",
7975
"src/friendli/container/__init__.py",
8076
"src/friendli/container/chat.py",
8177
"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",
9278
"src/friendli/dataset/__init__.py",
9379
"src/friendli/dataset/dataset.py",
9480
"src/friendli/file/__init__.py",
9581
"src/friendli/file/file.py",
96-
"src/friendli_core/friendlicore_serverless_chat.py",
82+
"src/friendli_core/completions.py",
9783
"src/friendli_core/file.py",
9884
"src/friendli_core/container.py",
85+
"src/friendli_core/chat.py",
9986
"src/friendli_core/friendlicore_image.py",
10087
"src/friendli_core/friendlicore_completions.py",
101-
"src/friendli_core/friendlicore_serverless_token.py",
88+
"src/friendli_core/image.py",
10289
"src/friendli_core/toolassistedchat.py",
90+
"src/friendli_core/dataset.py",
10391
"src/friendli_core/token.py",
10492
"src/friendli_core/friendlicore_token.py",
105-
"src/friendli_core/friendlicore_serverless_completions.py",
10693
"src/friendli_core/friendlicore_chat.py",
10794
"src/friendli_core/knowledge.py",
10895
"src/friendli_core/audio.py"
@@ -123,6 +110,7 @@
123110
"assigned_files": [
124111
"src/friendli/models.py",
125112
"src/friendli/types.py",
113+
"src/friendli_core/model.py",
126114
"src/friendli_core/models/containerdetokenizationop.py",
127115
"src/friendli_core/models/splitinfo.py",
128116
"src/friendli_core/models/dedicatedgetendpointstatusop.py",
@@ -213,7 +201,7 @@
213201
"src/friendli_core/models/dedicatedgetendpointop.py",
214202
"src/friendli_core/models/list_versionsop.py",
215203
"src/friendli_core/models/completionsstreamdedicatedbodywithtokens.py",
216-
"src/friendli_core/models/completionsstreamserverlessbodywithprompt.py",
204+
"src/friendli_core/models/completionsstreamserverlessbodywithtokens.py",
217205
"src/friendli_core/models/streamedcompletionschoice.py",
218206
"src/friendli_core/models/get_versionop.py",
219207
"src/friendli_core/models/toolassistedchattool.py",
@@ -356,13 +344,25 @@
356344
}
357345
],
358346
"assigned_files": [
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",
347+
"src/friendli/serverless/completions.py",
362348
"src/friendli/serverless/__init__.py",
349+
"src/friendli/serverless/chat.py",
350+
"src/friendli/serverless/tool_assisted_chat.py",
363351
"src/friendli/serverless/model.py",
352+
"src/friendli/serverless/token.py",
353+
"src/friendli/serverless/knowledge.py",
354+
"src/friendli/dedicated/completions.py",
364355
"src/friendli/dedicated/__init__.py",
365-
"src/friendli/dedicated/endpoint.py"
356+
"src/friendli/dedicated/chat.py",
357+
"src/friendli/dedicated/endpoint.py",
358+
"src/friendli/dedicated/image.py",
359+
"src/friendli/dedicated/token.py",
360+
"src/friendli/dedicated/audio.py",
361+
"src/friendli_core/friendlicore_serverless_chat.py",
362+
"src/friendli_core/dedicated.py",
363+
"src/friendli_core/friendlicore_serverless_token.py",
364+
"src/friendli_core/serverless.py",
365+
"src/friendli_core/friendlicore_serverless_completions.py"
366366
],
367367
"can_expand": true
368368
},
@@ -391,6 +391,7 @@
391391
"referenced_source_code": [],
392392
"assigned_files": [
393393
"src/friendli/utils.py",
394+
"src/friendli_core/_version.py",
394395
"src/friendli_core/utils/metadata.py",
395396
"src/friendli_core/utils/__init__.py",
396397
"src/friendli_core/utils/forms.py",
@@ -525,6 +526,13 @@
525526
"assigned_files": [],
526527
"can_expand": false
527528
},
529+
{
530+
"name": "Unclassified",
531+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
532+
"referenced_source_code": [],
533+
"assigned_files": [],
534+
"can_expand": false
535+
},
528536
{
529537
"name": "Unclassified",
530538
"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": "6a93a3a37493a4fe3835b9f93030664d9f895966",
2+
"commit_hash": "1def28d72026955db7b012597f0a488a89928ade",
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
@@ -24,6 +24,7 @@ graph LR
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
27+
Unclassified["Unclassified"]
2728
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2829
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2930
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -207,6 +208,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
207208
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
208209

209210

211+
**Related Classes/Methods**: _None_
212+
213+
### Unclassified
214+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
215+
216+
210217
**Related Classes/Methods**: _None_
211218

212219

‎docs/architecture/on_boarding.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,3 +257,11 @@ _Last updated: 2026-01-10 20:36:29 UTC_
257257
- [overview.md](./overview.md)
258258

259259
_Last updated: 2026-01-17 20:36:12 UTC_
260+
- [Data_Models_Error_Handling.md](./Data_Models_Error_Handling.md)
261+
- [Friendli_Client_Public_API_.md](./Friendli_Client_Public_API_.md)
262+
- [Platform_Abstractions.md](./Platform_Abstractions.md)
263+
- [SDK_Core.md](./SDK_Core.md)
264+
- [Service_Modules.md](./Service_Modules.md)
265+
- [overview.md](./overview.md)
266+
267+
_Last updated: 2026-01-24 20:36:21 UTC_

‎docs/architecture/overview.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ graph LR
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
27+
Unclassified["Unclassified"]
2728
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2829
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2930
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -207,6 +208,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
207208
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
208209

209210

211+
**Related Classes/Methods**: _None_
212+
213+
### Unclassified
214+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
215+
216+
210217
**Related Classes/Methods**: _None_
211218

212219

0 commit comments

Comments
 (0)