# dimaag-ai/akri-de-examples architecture

> Architecture diagram of the GitHub repository dimaag-ai/akri-de-examples, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dimaag-ai/akri-de-examples
- Repository: https://github.com/dimaag-ai/akri-de-examples

## Overview

This repository is a collection of Python examples for Akridata’s visual-data-curation SDK, rather than the SDK implementation itself. The principal workflow registers a dataset, ingests images, creates an exploration job, then retrieves clusters, samples or visual-search results and saves a resultset. A separate example imports catalog metadata and runs model-accuracy analysis. The SDK and Data Explorer internals are external to this tree; the edges show documented example calls, not their internal implementation. Sampled files support the main flow and analysis; other README capabilities are retained as documented branches.

Main entry points: [`python_examples/complete_flow.py`](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/complete_flow.py) (Complete flow), [`python_examples/display_images.py`](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/display_images.py) (Image display), [`python_examples/akride_analyze_model.py`](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/akride_analyze_model.py) (Accuracy analysis), [`python_examples/sample_display_clusters.py`](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/sample_display_clusters.py) (Cluster retrieval)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Curation workflow"]
  node_complete["Complete flow<br/>[complete_flow.py]"]
  node_create["Dataset creation<br/>[create_dataset.py]"]
  node_ingest["Image ingestion<br/>[ingest_data.py]"]
  node_explore["Explore job<br/>[explore_data.py]"]
  node_view["Job visualization<br/>[view_dataset.py]"]
  node_clusters["Cluster retrieval"]
  node_coreset["Coreset sampling"]
  node_search["Visual search<br/>[visual_search.py]"]
  node_resultset["Resultsets<br/>[resultset.py]"]
end

subgraph group_analysis["Model analysis"]
  node_analysis_flow["Accuracy analysis"]
end

subgraph group_presentation["Result presentation"]
  node_display["Image display<br/>[display_images.py]"]
end

node_user(("Python user"))
node_sdk{{"AkriDE SDK"}}
node_explorer{{"Data Explorer"}}

node_user -->|"runs"| node_complete
node_complete -->|"registers dataset"| node_sdk
node_complete -->|"ingests images"| node_sdk
node_complete -->|"creates job"| node_sdk
node_complete -->|"retrieves samples"| node_sdk
node_complete -->|"creates resultset"| node_sdk
node_complete -->|"displays thumbnails"| node_display
node_create -->|"registers dataset"| node_sdk
node_ingest -->|"ingests images"| node_sdk
node_explore -->|"creates job"| node_sdk
node_view -->|"gets display URL"| node_sdk
node_clusters -->|"retrieves clusters"| node_sdk
node_clusters -->|"displays thumbnails"| node_display
node_coreset -->|"samples dataset"| node_sdk
node_coreset -->|"displays thumbnails"| node_display
node_search -->|"searches images"| node_sdk
node_search -->|"displays thumbnails"| node_display
node_resultset -->|"saves and retrieves"| node_sdk
node_resultset -->|"displays thumbnails"| node_display
node_analysis_flow -->|"imports catalog"| node_sdk
node_analysis_flow -->|"creates analysis job"| node_sdk
node_analysis_flow -->|"gets statistics"| node_sdk
node_analysis_flow -->|"displays examples"| node_display
node_sdk -.->|"uses service"| node_explorer

click node_complete "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/complete_flow.py"
click node_create "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/create_dataset.py"
click node_ingest "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/ingest_data.py"
click node_explore "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/explore_data.py"
click node_view "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/view_dataset.py"
click node_clusters "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/sample_display_clusters.py"
click node_coreset "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/coreset_sample_data.py"
click node_search "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/visual_search.py"
click node_resultset "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/resultset.py"
click node_analysis_flow "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/akride_analyze_model.py"
click node_display "https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/display_images.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_complete,node_create,node_ingest,node_explore,node_view,node_clusters,node_coreset,node_search,node_resultset,node_user toneBlue
class node_analysis_flow toneAmber
class node_display toneMint
class node_sdk,node_explorer toneIndigo
```

## Components

### Curation workflow

- [Complete flow](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/complete_flow.py): `python_examples/complete_flow.py`
- [Dataset creation](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/create_dataset.py): `python_examples/create_dataset.py`
- [Image ingestion](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/ingest_data.py): `python_examples/ingest_data.py`
- [Explore job](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/explore_data.py): `python_examples/explore_data.py`
- [Job visualization](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/view_dataset.py): `python_examples/view_dataset.py`
- [Cluster retrieval](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/sample_display_clusters.py): `python_examples/sample_display_clusters.py`
- [Coreset sampling](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/coreset_sample_data.py): `python_examples/coreset_sample_data.py`
- [Visual search](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/visual_search.py): `python_examples/visual_search.py`
- [Resultsets](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/resultset.py): `python_examples/resultset.py`

### Model analysis

- [Accuracy analysis](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/akride_analyze_model.py): `python_examples/akride_analyze_model.py`

### Result presentation

- [Image display](https://github.com/dimaag-ai/akri-de-examples/blob/main/python_examples/display_images.py): `python_examples/display_images.py`

### Other components

- **Python user**
- **AkriDE SDK**
- **Data Explorer**

## Connections

- Python user → Complete flow: runs (evidence: `README.md`)
- Complete flow → AkriDE SDK: registers dataset (evidence: `python_examples/complete_flow.py`)
- Complete flow → AkriDE SDK: ingests images (evidence: `python_examples/complete_flow.py`)
- Complete flow → AkriDE SDK: creates job (evidence: `python_examples/complete_flow.py`)
- Complete flow → AkriDE SDK: retrieves samples (evidence: `python_examples/complete_flow.py`)
- Complete flow → AkriDE SDK: creates resultset (evidence: `python_examples/complete_flow.py`)
- Complete flow → Image display: displays thumbnails (evidence: `python_examples/complete_flow.py`)
- Dataset creation → AkriDE SDK: registers dataset (evidence: `python_examples/create_dataset.py`)
- Image ingestion → AkriDE SDK: ingests images (evidence: `python_examples/ingest_data.py`)
- Explore job → AkriDE SDK: creates job (evidence: `python_examples/explore_data.py`)
- Job visualization → AkriDE SDK: gets display URL (evidence: `python_examples/view_dataset.py`)
- Cluster retrieval → AkriDE SDK: retrieves clusters (evidence: `python_examples/sample_display_clusters.py`)
- Cluster retrieval → Image display: displays thumbnails (evidence: `python_examples/sample_display_clusters.py`)
- Coreset sampling → AkriDE SDK: samples dataset (evidence: `python_examples/coreset_sample_data.py`)
- Coreset sampling → Image display: displays thumbnails (evidence: `python_examples/coreset_sample_data.py`)
- Visual search → AkriDE SDK: searches images (evidence: `python_examples/visual_search.py`)
- Visual search → Image display: displays thumbnails (evidence: `python_examples/visual_search.py`)
- Resultsets → AkriDE SDK: saves and retrieves (evidence: `python_examples/resultset.py`)
- Resultsets → Image display: displays thumbnails (evidence: `python_examples/resultset.py`)
- Accuracy analysis → AkriDE SDK: imports catalog (evidence: `python_examples/akride_analyze_model.py`)
- Accuracy analysis → AkriDE SDK: creates analysis job (evidence: `python_examples/akride_analyze_model.py`)
- Accuracy analysis → AkriDE SDK: gets statistics (evidence: `python_examples/akride_analyze_model.py`)
- Accuracy analysis → Image display: displays examples (evidence: `python_examples/akride_analyze_model.py`)
- AkriDE SDK → Data Explorer: uses service (evidence: `README.md`)