Skip to content

on_boarding.md

Latest commit

 

History

History
267 lines (210 loc) · 11.6 KB

on_boarding.md

File metadata and controls

267 lines (210 loc) · 11.6 KB
graph LR
    Friendli_Client_Public_API_["Friendli Client (Public API)"]
    SDK_Core["SDK Core"]
    Service_Modules["Service Modules"]
    Data_Models_Error_Handling["Data Models & Error Handling"]
    Platform_Abstractions["Platform Abstractions"]
    Hooks_Extensibility["Hooks & Extensibility"]
    Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
    SDK_Core -- "utilizes" --> Data_Models_Error_Handling
    SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
    SDK_Core -- "integrates and consumes" --> Hooks_Extensibility
    Service_Modules -- "utilize" --> SDK_Core
    Service_Modules -- "rely on" --> Data_Models_Error_Handling
    click Friendli_Client_Public_API_ href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Friendli_Client_Public_API_.md" "Details"
    click SDK_Core href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/SDK_Core.md" "Details"
    click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
    click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
    click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
    click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
Loading

CodeBoardingDemoContact

Details

One paragraph explaining the functionality which is represented by this graph. What the main flow is and what is its purpose.

Friendli Client (Public API) [Expand]

The primary entry point for end-users, offering a high-level, consistent interface for interacting with the Friendli AI platform, supporting both synchronous and asynchronous operations.

Related Classes/Methods:

  • friendli_core.sdk

SDK Core [Expand]

The central orchestrator managing fundamental logic for API communication, request/response processing, and integrating foundational SDK abstractions and extensibility points.

Related Classes/Methods:

  • friendli_core.basesdk

Service Modules [Expand]

Encapsulate specific API domains (e.g., chat, completions, datasets), providing high-level, domain-specific methods that simplify interactions with particular parts of the Friendli API.

Related Classes/Methods:

  • friendli_core.chat
  • friendli_core.completions
  • friendli_core.dataset
  • friendli_core.image

Data Models & Error Handling [Expand]

Defines standardized data structures for API requests and responses, along with a comprehensive set of error types, ensuring consistent data representation and robust error reporting.

Related Classes/Methods:

  • friendli_core.models

Platform Abstractions [Expand]

Provides base structures and interfaces tailored for different operational modes or deployment types within the Friendli platform, enabling the SDK to adapt its behavior to the target environment.

Related Classes/Methods:

  • friendli_core.dedicated
  • friendli_core.serverless

Hooks & Extensibility [Expand]

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.

Related Classes/Methods:

  • friendli_core._hooks

FAQ

Last updated: 2025-08-30 20:26:36 UTC

Last updated: 2025-09-06 20:25:32 UTC

Last updated: 2025-09-13 20:27:42 UTC

Last updated: 2025-09-20 20:28:14 UTC

Last updated: 2025-09-27 20:30:20 UTC

Last updated: 2025-10-04 20:31:16 UTC

Last updated: 2025-10-11 20:28:27 UTC

Last updated: 2025-10-18 20:31:42 UTC

Last updated: 2025-10-25 20:31:31 UTC

Last updated: 2025-11-08 20:30:16 UTC

Last updated: 2025-11-15 20:35:14 UTC

Last updated: 2025-11-22 20:33:01 UTC

Last updated: 2025-11-29 20:36:48 UTC

Last updated: 2025-12-06 20:34:16 UTC

Last updated: 2025-12-13 20:34:17 UTC

Last updated: 2025-12-20 20:34:05 UTC

Last updated: 2025-12-27 20:35:57 UTC

Last updated: 2026-01-03 20:39:50 UTC

Last updated: 2026-01-10 20:36:29 UTC

Last updated: 2026-01-17 20:36:12 UTC

Last updated: 2026-01-24 20:36:21 UTC