# tensorflow/codelabs architecture

> Architecture diagram of the GitHub repository tensorflow/codelabs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tensorflow/codelabs
- Repository: https://github.com/tensorflow/codelabs

## Overview

##### Project type and purpose
- This is a monorepo of TensorFlow “codelab” samples—an open-source collection of end-to-end sample code across multiple domains (image, text, audio, object detection, product search, comment-spam, NLP, Serving, etc.) and multiple platforms (Android, iOS, Web, Python Colab, TFJS, TensorFlow Serving, etc.).
- The README simply says “sample code for several TensorFlow codelabs” and points to Google ML pathways. There is no single runtime system; rather, each subfolder is a self-contained tutorial.

##### File structure
- Top-level folders are grouped by codelab domain (e.g., ODML, audio_classification, comment-spam, object-detection, product-search, TextClassificationOnMobile, TFServing/ImageClassificationWeb, etc.).
– Android (Gradle, .java/.kt, assets, TFLite libs)
– iOS (Xcode project, Swift code, TFLite/TF Serving stubs)
– Colab notebooks (.ipynb) and Python scripts (.py)
– Web (Node.js + gRPC-Web, Envoy proxy, compiled JS clients)
– TFJS models (model.json + shards)
- Shared assets include model binaries (.tflite), vocab/labels, and protobuf definitions for TF Serving.

##### README
- It simply describes the repo as “sample code for several TensorFlow codelabs” without an architectural overview.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Monorepo Root
    Monorepo["Monorepo Root"]:::repo

    %% ODML Domains
    subgraph "ODML Domains"
        subgraph "ImageClassificationMobile"
            ICM_colab["CustomImageClassifierModel.ipynb"]:::python
            ICM_Android1["Android Step1"]:::android
            ICM_Android2["Android Step2"]:::android
            ICM_iOS1["iOS Step1"]:::ios
            ICM_iOS2["iOS Step2"]:::ios
        end
        subgraph "TextClassificationOnMobile"
            TCM_Android1["Android Step1"]:::android
            TCM_Android2["Android Step2"]:::android
            TCM_Android3["Android Step3"]:::android
            TCM_iOS1["iOS Step1"]:::ios
            TCM_iOS2["iOS Step2"]:::ios
            TCM_iOS3["iOS Step3"]:::ios
            TCM_colab["Colab Notebooks"]:::python
            TCM_models["TFJS & TFLite Models"]:::model
        end
        subgraph "AudioClassification"
            AC_colab["model_maker_audio_colab.ipynb"]:::python
            AC_S1_starter["Codelab1 Android Starter"]:::android
            AC_S1_final["Codelab1 Android Final"]:::android
            AC_S2_starter["Codelab2 Android Starter"]:::android
            AC_S2_final["Codelab2 Android Final"]:::android
        end
        subgraph "Comment-Spam"
            CS1_starter["Codelab1 Web Starter"]:::web
            CS1_final["Codelab1 Web Final"]:::web
            CS2_starter["Codelab2 Web Starter"]:::web
            CS2_final["Codelab2 Web Final"]:::web
        end
        subgraph "ObjectDetection"
            OD_S2_starter["Codelab2 Android Starter"]:::android
            OD_S2_final["Codelab2 Android Final"]:::android
            OD_colab["Train_a_salad_detector...ipynb"]:::python
        end
        subgraph "ProductSearch"
            PS1_starter["Codelab1 Android Starter"]:::android
            PS1_final["Codelab1 Android Final"]:::android
            PS2_starter["Codelab2 Android Starter"]:::android
            PS2_final["Codelab2 Android Final"]:::android
        end
    end

    %% KerasNLP & TFRecommenders
    subgraph "KerasNLP"
        KNL_colab["io2023_workshop.ipynb"]:::python
        KNL_json["gpt2_colab.json"]:::model
    end
    subgraph "TFRecommenders"
        TFR["README.md"]:::repo
    end

    %% TFServing Samples
    subgraph "TFServing Samples"
        subgraph "ImageClassificationWeb"
            ICW_starter["Starter"]:::web
            ICW_finished["Finished"]:::web
        end
        subgraph "ObjectDetectionAndroid"
            ODA_starter["Starter"]:::android
            ODA_finished["Finished"]:::android
        end
        subgraph "RegressioniOS"
            RIOS_starter["Starter"]:::ios
            RIOS_finished["Finished"]:::ios
        end
        Envoy["Envoy Proxy"]:::server
        TFServing["TensorFlow Serving"]:::server
    end

    %% Shared Artifacts
    Shared["Shared Artifacts\n(models, vocab/labels, proto)"]:::storage

    %% Relationships
    %% ODML flows
    ICM_colab -->|"generates"| Shared
    Shared -->|"loads"| ICM_Android1
    Shared -->|"loads"| ICM_Android2
    Shared -->|"loads"| ICM_iOS1
    Shared -->|"loads"| ICM_iOS2

    TCM_colab -->|"generates"| Shared
    Shared -->|"loads"| TCM_Android1
    Shared -->|"loads"| TCM_Android2
    Shared -->|"loads"| TCM_Android3
    Shared -->|"loads"| TCM_iOS1
    Shared -->|"loads"| TCM_iOS2
    Shared -->|"loads"| TCM_iOS3
    Shared -->|"provides"| TCM_models

    AC_colab -->|"generates"| Shared
    Shared -->|"loads"| AC_S1_starter
    Shared -->|"loads"| AC_S1_final
    Shared -->|"loads"| AC_S2_starter
    Shared -->|"loads"| AC_S2_final

    OD_colab -->|"generates"| Shared
    Shared -->|"loads"| OD_S2_starter
    Shared -->|"loads"| OD_S2_final

    %% Web inference flow
    ICW_starter -->|"PredictRequest"| Envoy
    ICW_finished -->|"PredictRequest"| Envoy
    Envoy -->|"gRPC"| TFServing

    CS1_starter -->|"client-side inference"| Shared
    CS1_final -->|"client-side inference"| Shared
    CS2_starter -->|"client-side inference"| Shared
    CS2_final -->|"client-side inference"| Shared

    %% ProductSearch flow
    Shared -->|"loads"| PS1_starter
    Shared -->|"loads"| PS1_final
    Shared -->|"loads"| PS2_starter
    Shared -->|"loads"| PS2_final

    %% KerasNLP flow
    KNL_colab -->|"generates"| Shared
    Shared -->|"loads"| KNL_json

    %% TFRecommenders is documentation only

    %% Root connections
    Monorepo -->|"contains"| ODML_Domains
    Monorepo -->|"contains"| KerasNLP
    Monorepo -->|"contains"| TFRecommenders
    Monorepo -->|"contains"| TFServing_Samples

    %% Click Events
    click Monorepo "https://github.com/tensorflow/codelabs/tree/main/./"
    click ICM_Android1 "https://github.com/tensorflow/codelabs/tree/main/ODML/ImageClassificationMobile/android/ImageClassifierStep1"
    click ICM_Android2 "https://github.com/tensorflow/codelabs/tree/main/ODML/ImageClassificationMobile/android/ImageClassifierStep2"
    click ICM_iOS1 "https://github.com/tensorflow/codelabs/tree/main/ODML/ImageClassificationMobile/ios/ImageClassifierStep1"
    click ICM_iOS2 "https://github.com/tensorflow/codelabs/tree/main/ODML/ImageClassificationMobile/ios/ImageClassifierStep2"
    click ICM_colab "https://github.com/tensorflow/codelabs/blob/main/ODML/ImageClassificationMobile/colab/CustomImageClassifierModel.ipynb"
    click TCM_Android1 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/Android/TextClassificationStep1"
    click TCM_Android2 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/Android/TextClassificationStep2"
    click TCM_Android3 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/Android/TextClassificationStep3"
    click TCM_iOS1 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/iOS/TextClassificationStep1"
    click TCM_iOS2 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/iOS/TextClassificationStep2"
    click TCM_iOS3 "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/iOS/TextClassificationStep3"
    click TCM_colab "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/colabs"
    click TCM_models "https://github.com/tensorflow/codelabs/tree/main/ODML/TextClassificationOnMobile/models"
    click AC_colab "https://github.com/tensorflow/codelabs/blob/main/ODML/audio_classification/colab/model_maker_audio_colab.ipynb"
    click AC_S1_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/audio_classification/codelab1/android/starter"
    click AC_S1_final "https://github.com/tensorflow/codelabs/tree/main/ODML/audio_classification/codelab1/android/final"
    click AC_S2_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/audio_classification/codelab2/android/starter"
    click AC_S2_final "https://github.com/tensorflow/codelabs/tree/main/ODML/audio_classification/codelab2/android/final"
    click CS1_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/comment-spam/codelab1/web/starter"
    click CS1_final "https://github.com/tensorflow/codelabs/tree/main/ODML/comment-spam/codelab1/web/final"
    click CS2_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/comment-spam/codelab2/web/starter"
    click CS2_final "https://github.com/tensorflow/codelabs/tree/main/ODML/comment-spam/codelab2/web/final"
    click OD_S2_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/object-detection/codelab2/android/starter"
    click OD_S2_final "https://github.com/tensorflow/codelabs/tree/main/ODML/object-detection/codelab2/android/final"
    click OD_colab "https://github.com/tensorflow/codelabs/blob/main/ODML/object-detection/codelab2/python/Train_a_salad_detector_with_TFLite_Model_Maker.ipynb"
    click PS1_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/product-search/codelab1/android/starter"
    click PS1_final "https://github.com/tensorflow/codelabs/tree/main/ODML/product-search/codelab1/android/final"
    click PS2_starter "https://github.com/tensorflow/codelabs/tree/main/ODML/product-search/codelab2/android/starter"
    click PS2_final "https://github.com/tensorflow/codelabs/tree/main/ODML/product-search/codelab2/android/final"
    click KNL_colab "https://github.com/tensorflow/codelabs/blob/main/KerasNLP/io2023_workshop.ipynb"
    click KNL_json "https://github.com/tensorflow/codelabs/blob/main/KerasNLP/gpt2_colab.json"
    click TFR "https://github.com/tensorflow/codelabs/blob/main/TFRecommenders/README.md"
    click ICW_starter "https://github.com/tensorflow/codelabs/tree/main/TFServing/ImageClassificationWeb/starter"
    click ICW_finished "https://github.com/tensorflow/codelabs/tree/main/TFServing/ImageClassificationWeb/finished"
    click ODA_starter "https://github.com/tensorflow/codelabs/tree/main/TFServing/ObjectDetectionAndroid/starter"
    click ODA_finished "https://github.com/tensorflow/codelabs/tree/main/TFServing/ObjectDetectionAndroid/finished"
    click RIOS_starter "https://github.com/tensorflow/codelabs/tree/main/TFServing/RegressioniOS/starter"
    click RIOS_finished "https://github.com/tensorflow/codelabs/tree/main/TFServing/RegressioniOS/finished"

    %% Styles
    classDef android fill:#c6f6d5,stroke:#2f855a,color:#2f855a;
    classDef ios fill:#ebf8ff,stroke:#3182ce,color:#3182ce;
    classDef web fill:#fff5f0,stroke:#dd6b20,color:#dd6b20;
    classDef python fill:#faf5ff,stroke:#805ad5,color:#805ad5;
    classDef model fill:#fffff0,stroke:#d69e2e,color:#d69e2e;
    classDef storage fill:#f0fff4,stroke:#38a169,color:#38a169;
    classDef server fill:#f7fafc,stroke:#4a5568,color:#4a5568;
    classDef repo fill:#edf2f7,stroke:#a0aec0,color:#2d3748;
```
