Skip to content

Commit bcf5e5c

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 3d511e2 commit bcf5e5c

12 files changed

+78
-78
lines changed

‎.codeboarding/Data_Models_Error_Handling.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The central entry point for the SDK, responsible for managing authentication, se
2929

3030
**Related Classes/Methods**:
3131

32-
- `friendli_core.client` (1:1)
32+
- `friendli_core.client`
3333

3434

3535
### Service Modules [[Expand]](./Service_Modules.md)
@@ -50,8 +50,8 @@ Defines standardized data structures for all API requests and responses, ensurin
5050

5151
**Related Classes/Methods**:
5252

53-
- `friendli_core.models` (1:1)
54-
- `friendli_core.errors` (1:1)
53+
- `friendli_core.models`
54+
- `friendli_core.errors`
5555

5656

5757
### Utility Functions
@@ -60,7 +60,7 @@ Provides common helper functions for SDK-wide tasks such as JSON serialization/d
6060

6161
**Related Classes/Methods**:
6262

63-
- `friendli_core.utils` (1:1)
63+
- `friendli_core.utils`
6464

6565

6666
### Examples and Documentation
@@ -69,8 +69,8 @@ Comprises practical code examples demonstrating how to effectively use the SDK's
6969

7070
**Related Classes/Methods**:
7171

72-
- `examples` (1:1)
73-
- `docs` (1:1)
72+
- `examples`
73+
- `docs`
7474

7575

7676

‎.codeboarding/Friendli_Client_Public_API_.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Encapsulate the logic for interacting with specific API endpoints (e.g., chat, c
4444

4545
- `friendli_core.chat`
4646
- `friendli_core.completions`
47-
- `friendli_core.images` (1:1)
47+
- `friendli_core.images`
4848
- `friendli_core.audio`
4949

5050

@@ -54,7 +54,7 @@ Define the structure of data exchanged with the Friendli AI platform, including
5454

5555
**Related Classes/Methods**:
5656

57-
- `friendli_core.models` (1:1)
57+
- `friendli_core.models`
5858

5959

6060
### HTTP Client/Transport Layer
@@ -63,7 +63,7 @@ Handles the low-level HTTP communication with the Friendli AI platform. This inc
6363

6464
**Related Classes/Methods**:
6565

66-
- `friendli_core.http_client` (1:1)
66+
- `friendli_core.http_client`
6767

6868

6969
### Error Handling [[Expand]](./Error_Handling.md)
@@ -72,7 +72,7 @@ Manages and standardizes error responses from both the API and the network layer
7272

7373
**Related Classes/Methods**:
7474

75-
- `friendli_core.errors` (1:1)
75+
- `friendli_core.errors`
7676

7777

7878
### Configuration Management
@@ -81,7 +81,7 @@ Centralizes and manages SDK-wide configuration settings, such as API keys, base
8181

8282
**Related Classes/Methods**:
8383

84-
- `friendli_core.config` (1:1)
84+
- `friendli_core.config`
8585

8686

8787
### Utility Functions
@@ -90,7 +90,7 @@ Provides common helper functions and reusable functionalities that support vario
9090

9191
**Related Classes/Methods**:
9292

93-
- `friendli_core.utils` (1:1)
93+
- `friendli_core.utils`
9494

9595

9696

‎.codeboarding/Hooks_Extensibility.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ A set of specialized Data Transfer Objects (DTOs) that encapsulate and pass rele
2121

2222
**Related Classes/Methods**:
2323

24-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L11-L30" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.HookContext` (11:30)</a>
25-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L33-L41" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.BeforeRequestContext` (33:41)</a>
26-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L44-L52" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.AfterSuccessContext` (44:52)</a>
27-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L55-L63" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.AfterErrorContext` (55:63)</a>
24+
- `friendli_core._hooks.types.HookContext`:11-30
25+
- `friendli_core._hooks.types.BeforeRequestContext`:33-41
26+
- `friendli_core._hooks.types.AfterSuccessContext`:44-52
27+
- `friendli_core._hooks.types.AfterErrorContext`:55-63
2828

2929

3030
### Hook Interface
@@ -33,7 +33,7 @@ Defines the abstract interface or base class that custom hooks must implement. I
3333

3434
**Related Classes/Methods**:
3535

36-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L99-L114" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.Hooks` (99:114)</a>
36+
- `friendli_core._hooks.types.Hooks`:99-114
3737

3838

3939
### SDK Hooks Orchestrator
@@ -42,7 +42,7 @@ The central manager responsible for registering, storing, and orchestrating the
4242

4343
**Related Classes/Methods**:
4444

45-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/sdkhooks.py#L21-L78" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.sdkhooks.SDKHooks` (21:78)</a>
45+
- `friendli_core._hooks.sdkhooks.SDKHooks`:21-78
4646

4747

4848

‎.codeboarding/Platform_Abstractions.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Defines the foundational base structures and interfaces that enable the SDK to a
2020

2121
**Related Classes/Methods**:
2222

23-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/basesdk.py#L19-L106" target="_blank" rel="noopener noreferrer">`friendli_core.basesdk:BaseSDK` (19:106)</a>
23+
- `friendli_core.basesdk:BaseSDK`:19-106
2424

2525

2626
### Dedicated Client
@@ -29,9 +29,9 @@ A concrete implementation of the `Platform Abstractions` tailored specifically f
2929

3030
**Related Classes/Methods**:
3131

32-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L24-L32" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:BaseDedicated` (24:32)</a>
33-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L35-L49" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:SyncDedicated` (35:49)</a>
34-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L52-L66" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:AsyncDedicated` (52:66)</a>
32+
- `friendli_core.dedicated:BaseDedicated`:24-32
33+
- `friendli_core.dedicated:SyncDedicated`:35-49
34+
- `friendli_core.dedicated:AsyncDedicated`:52-66
3535

3636

3737
### Serverless Client
@@ -40,9 +40,9 @@ A concrete implementation of the `Platform Abstractions` designed for interactin
4040

4141
**Related Classes/Methods**:
4242

43-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L24-L32" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:BaseServerless` (24:32)</a>
44-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L35-L49" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:SyncServerless` (35:49)</a>
45-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L52-L68" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:AsyncServerless` (52:68)</a>
43+
- `friendli_core.serverless:BaseServerless`:24-32
44+
- `friendli_core.serverless:SyncServerless`:35-49
45+
- `friendli_core.serverless:AsyncServerless`:52-68
4646

4747

4848

‎.codeboarding/Service_Modules.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ These modules encapsulate the core API domain logic for specific functionalities
2424

2525
**Related Classes/Methods**:
2626

27-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/chat.py#L18-L372" target="_blank" rel="noopener noreferrer">`friendli_core.chat.SyncChat` (18:372)</a>
28-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/chat.py#L375-L729" target="_blank" rel="noopener noreferrer">`friendli_core.chat.AsyncChat` (375:729)</a>
29-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/completions.py#L18-L194" target="_blank" rel="noopener noreferrer">`friendli_core.completions.SyncCompletions` (18:194)</a>
30-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/completions.py#L197-L373" target="_blank" rel="noopener noreferrer">`friendli_core.completions.AsyncCompletions` (197:373)</a>
31-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dataset.py#L19-L1528" target="_blank" rel="noopener noreferrer">`friendli_core.dataset.SyncDataset` (19:1528)</a>
32-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dataset.py#L1531-L3040" target="_blank" rel="noopener noreferrer">`friendli_core.dataset.AsyncDataset` (1531:3040)</a>
33-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/image.py#L18-L118" target="_blank" rel="noopener noreferrer">`friendli_core.image.SyncImage` (18:118)</a>
34-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/image.py#L121-L221" target="_blank" rel="noopener noreferrer">`friendli_core.image.AsyncImage` (121:221)</a>
27+
- `friendli_core.chat.SyncChat`:18-372
28+
- `friendli_core.chat.AsyncChat`:375-729
29+
- `friendli_core.completions.SyncCompletions`:18-194
30+
- `friendli_core.completions.AsyncCompletions`:197-373
31+
- `friendli_core.dataset.SyncDataset`:19-1528
32+
- `friendli_core.dataset.AsyncDataset`:1531-3040
33+
- `friendli_core.image.SyncImage`:18-118
34+
- `friendli_core.image.AsyncImage`:121-221
3535

3636

3737
### Security Utility
@@ -40,7 +40,7 @@ Responsible for securely retrieving and managing API credentials, typically from
4040

4141
**Related Classes/Methods**:
4242

43-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/utils/security.py#L57-L69" target="_blank" rel="noopener noreferrer">`friendli_core.utils.security.get_security_from_env` (57:69)</a>
43+
- `friendli_core.utils.security.get_security_from_env`:57-69
4444

4545

4646
### JSON Unmarshalling Utility
@@ -49,7 +49,7 @@ Handles the deserialization of JSON responses received from the Friendli API int
4949

5050
**Related Classes/Methods**:
5151

52-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/utils/unmarshal_json_response.py#L11-L24" target="_blank" rel="noopener noreferrer">`friendli_core.utils.unmarshal_json_response.unmarshal_json_response` (11:24)</a>
52+
- `friendli_core.utils.unmarshal_json_response.unmarshal_json_response`:11-24
5353

5454

5555
### Event Streaming Utility
@@ -58,8 +58,8 @@ Provides mechanisms for processing and managing streaming responses from the API
5858

5959
**Related Classes/Methods**:
6060

61-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/utils/eventstreaming.py#L19-L42" target="_blank" rel="noopener noreferrer">`friendli_core.utils.eventstreaming.EventStream` (19:42)</a>
62-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/utils/eventstreaming.py#L45-L68" target="_blank" rel="noopener noreferrer">`friendli_core.utils.eventstreaming.EventStreamAsync` (45:68)</a>
61+
- `friendli_core.utils.eventstreaming.EventStream`:19-42
62+
- `friendli_core.utils.eventstreaming.EventStreamAsync`:45-68
6363

6464

6565
### Hook Context Management
@@ -68,7 +68,7 @@ Manages an extensibility mechanism that allows developers to inject custom logic
6868

6969
**Related Classes/Methods**:
7070

71-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L11-L30" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.HookContext` (11:30)</a>
71+
- `friendli_core._hooks.types.HookContext`:11-30
7272

7373

7474

‎.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": "46ff1e4ea0a7512e7d24a67e830ecc2a277795a5",
2+
"commit_hash": "3d511e21833d2601fefe487ede8eedad117d7150",
33
"code_boarding_version": "0.1.0"
44
}

‎docs/architecture/Data_Models_Error_Handling.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The central entry point for the SDK, responsible for managing authentication, se
2929

3030
**Related Classes/Methods**:
3131

32-
- `friendli_core.client` (1:1)
32+
- `friendli_core.client`
3333

3434

3535
### Service Modules [[Expand]](./Service_Modules.md)
@@ -50,8 +50,8 @@ Defines standardized data structures for all API requests and responses, ensurin
5050

5151
**Related Classes/Methods**:
5252

53-
- `friendli_core.models` (1:1)
54-
- `friendli_core.errors` (1:1)
53+
- `friendli_core.models`
54+
- `friendli_core.errors`
5555

5656

5757
### Utility Functions
@@ -60,7 +60,7 @@ Provides common helper functions for SDK-wide tasks such as JSON serialization/d
6060

6161
**Related Classes/Methods**:
6262

63-
- `friendli_core.utils` (1:1)
63+
- `friendli_core.utils`
6464

6565

6666
### Examples and Documentation
@@ -69,8 +69,8 @@ Comprises practical code examples demonstrating how to effectively use the SDK's
6969

7070
**Related Classes/Methods**:
7171

72-
- `examples` (1:1)
73-
- `docs` (1:1)
72+
- `examples`
73+
- `docs`
7474

7575

7676

‎docs/architecture/Friendli_Client_Public_API_.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Encapsulate the logic for interacting with specific API endpoints (e.g., chat, c
4444

4545
- `friendli_core.chat`
4646
- `friendli_core.completions`
47-
- `friendli_core.images` (1:1)
47+
- `friendli_core.images`
4848
- `friendli_core.audio`
4949

5050

@@ -54,7 +54,7 @@ Define the structure of data exchanged with the Friendli AI platform, including
5454

5555
**Related Classes/Methods**:
5656

57-
- `friendli_core.models` (1:1)
57+
- `friendli_core.models`
5858

5959

6060
### HTTP Client/Transport Layer
@@ -63,7 +63,7 @@ Handles the low-level HTTP communication with the Friendli AI platform. This inc
6363

6464
**Related Classes/Methods**:
6565

66-
- `friendli_core.http_client` (1:1)
66+
- `friendli_core.http_client`
6767

6868

6969
### Error Handling [[Expand]](./Error_Handling.md)
@@ -72,7 +72,7 @@ Manages and standardizes error responses from both the API and the network layer
7272

7373
**Related Classes/Methods**:
7474

75-
- `friendli_core.errors` (1:1)
75+
- `friendli_core.errors`
7676

7777

7878
### Configuration Management
@@ -81,7 +81,7 @@ Centralizes and manages SDK-wide configuration settings, such as API keys, base
8181

8282
**Related Classes/Methods**:
8383

84-
- `friendli_core.config` (1:1)
84+
- `friendli_core.config`
8585

8686

8787
### Utility Functions
@@ -90,7 +90,7 @@ Provides common helper functions and reusable functionalities that support vario
9090

9191
**Related Classes/Methods**:
9292

93-
- `friendli_core.utils` (1:1)
93+
- `friendli_core.utils`
9494

9595

9696

‎docs/architecture/Hooks_Extensibility.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ A set of specialized Data Transfer Objects (DTOs) that encapsulate and pass rele
2121

2222
**Related Classes/Methods**:
2323

24-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L11-L30" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.HookContext` (11:30)</a>
25-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L33-L41" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.BeforeRequestContext` (33:41)</a>
26-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L44-L52" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.AfterSuccessContext` (44:52)</a>
27-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L55-L63" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.AfterErrorContext` (55:63)</a>
24+
- `friendli_core._hooks.types.HookContext`:11-30
25+
- `friendli_core._hooks.types.BeforeRequestContext`:33-41
26+
- `friendli_core._hooks.types.AfterSuccessContext`:44-52
27+
- `friendli_core._hooks.types.AfterErrorContext`:55-63
2828

2929

3030
### Hook Interface
@@ -33,7 +33,7 @@ Defines the abstract interface or base class that custom hooks must implement. I
3333

3434
**Related Classes/Methods**:
3535

36-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/types.py#L99-L114" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.types.Hooks` (99:114)</a>
36+
- `friendli_core._hooks.types.Hooks`:99-114
3737

3838

3939
### SDK Hooks Orchestrator
@@ -42,7 +42,7 @@ The central manager responsible for registering, storing, and orchestrating the
4242

4343
**Related Classes/Methods**:
4444

45-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/_hooks/sdkhooks.py#L21-L78" target="_blank" rel="noopener noreferrer">`friendli_core._hooks.sdkhooks.SDKHooks` (21:78)</a>
45+
- `friendli_core._hooks.sdkhooks.SDKHooks`:21-78
4646

4747

4848

‎docs/architecture/Platform_Abstractions.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Defines the foundational base structures and interfaces that enable the SDK to a
2020

2121
**Related Classes/Methods**:
2222

23-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/basesdk.py#L19-L106" target="_blank" rel="noopener noreferrer">`friendli_core.basesdk:BaseSDK` (19:106)</a>
23+
- `friendli_core.basesdk:BaseSDK`:19-106
2424

2525

2626
### Dedicated Client
@@ -29,9 +29,9 @@ A concrete implementation of the `Platform Abstractions` tailored specifically f
2929

3030
**Related Classes/Methods**:
3131

32-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L24-L32" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:BaseDedicated` (24:32)</a>
33-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L35-L49" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:SyncDedicated` (35:49)</a>
34-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/dedicated.py#L52-L66" target="_blank" rel="noopener noreferrer">`friendli_core.dedicated:AsyncDedicated` (52:66)</a>
32+
- `friendli_core.dedicated:BaseDedicated`:24-32
33+
- `friendli_core.dedicated:SyncDedicated`:35-49
34+
- `friendli_core.dedicated:AsyncDedicated`:52-66
3535

3636

3737
### Serverless Client
@@ -40,9 +40,9 @@ A concrete implementation of the `Platform Abstractions` designed for interactin
4040

4141
**Related Classes/Methods**:
4242

43-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L24-L32" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:BaseServerless` (24:32)</a>
44-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L35-L49" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:SyncServerless` (35:49)</a>
45-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/src/friendli_core/serverless.py#L52-L68" target="_blank" rel="noopener noreferrer">`friendli_core.serverless:AsyncServerless` (52:68)</a>
43+
- `friendli_core.serverless:BaseServerless`:24-32
44+
- `friendli_core.serverless:SyncServerless`:35-49
45+
- `friendli_core.serverless:AsyncServerless`:52-68
4646

4747

4848

0 commit comments

Comments
 (0)