Adding an interactive diagram representation of mlx-lm to explore the codebase

[ivanmilevtues]

Hey all, I've always wanted to contribute to open-source projects. I am a visual learner, so I love doing diagrams for myself as in the beggining I find it hard to wrap my head around the main flow and the main "logical" components.
To help people who like visual represnetations I started working on a project to automate this. The tool generates an interactive diagram starting from the highest level of abstraction and allows you to dive deeper into interesting components.

Here is the diagram:

graph LR
    User_Interface_CLI_["User Interface (CLI)"]
    Model_Lifecycle_Management["Model Lifecycle Management"]
    LLM_Core_Inference_Architecture_["LLM Core (Inference & Architecture)"]
    Model_Optimization_Fine_tuning_Quantization_["Model Optimization (Fine-tuning & Quantization)"]
    Data_Evaluation["Data & Evaluation"]
    User_Interface_CLI_ -- "initiates commands to" --> Model_Lifecycle_Management
    User_Interface_CLI_ -- "triggers operations in" --> LLM_Core_Inference_Architecture_
    User_Interface_CLI_ -- "routes commands to" --> Model_Optimization_Fine_tuning_Quantization_
    User_Interface_CLI_ -- "directs commands to" --> Data_Evaluation
    Model_Lifecycle_Management -- "provides models to" --> LLM_Core_Inference_Architecture_
    Model_Optimization_Fine_tuning_Quantization_ -- "persists models via" --> Model_Lifecycle_Management
    Model_Optimization_Fine_tuning_Quantization_ -- "provides optimized models to" --> LLM_Core_Inference_Architecture_
    Model_Optimization_Fine_tuning_Quantization_ -- "requests datasets from" --> Data_Evaluation
    Data_Evaluation -- "supplies evaluation data to" --> LLM_Core_Inference_Architecture_
    click User_Interface_CLI_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/User_Interface_CLI_.md" "Details"
    click Model_Lifecycle_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/Model_Lifecycle_Management.md" "Details"
    click LLM_Core_Inference_Architecture_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/LLM_Core_Inference_Architecture_.md" "Details"
    click Model_Optimization_Fine_tuning_Quantization_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/Model_Optimization_Fine_tuning_Quantization_.md" "Details"
    click Data_Evaluation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/Data_Evaluation.md" "Details"

Loading

The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding

You can see the full diagram with explanations and related source code here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mlx-lm/on_boarding.md

Any feedback is appreciated! If you like it I would be more than happy to open a PR with all the diagrams and a free github action to keep them up-to-date.