# djsherwood/circe architecture

> Architecture diagram of the GitHub repository djsherwood/circe, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/djsherwood/circe
- Repository: https://github.com/djsherwood/circe

## Overview

This is a compact regression library for named numeric tables with discrete circular features. Its principal workflow is fitting a forest on training rows, then predicting from a table with the same columns and order. The implementation also supports ordinary threshold splits for non-circular features, including drift features such as cycle_number. The sampled source shows input validation and tree split behavior, but omits part of the forest-fitting implementation, so the graph stays at the public estimator boundary.

Main entry points: [`ring_forest.py`](https://github.com/djsherwood/circe/blob/main/ring_forest.py) (Ring forest estimator)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("User"))
node_estimator["Ring forest estimator<br/>[ring_forest.py]"]
node_predictions["Predictions"]

node_user -->|"fits and predicts"| node_estimator
node_estimator -->|"returns predictions"| node_predictions

click node_estimator "https://github.com/djsherwood/circe/blob/main/ring_forest.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_user toneBlue
class node_estimator toneTeal
class node_predictions toneIndigo
```

## Components

### Other components

- **User**
- [Ring forest estimator](https://github.com/djsherwood/circe/blob/main/ring_forest.py): `ring_forest.py`
- **Predictions**

## Connections

- User → Ring forest estimator: fits and predicts (evidence: `README.md`)
- Ring forest estimator → Predictions: returns predictions (evidence: `README.md`)
