# jswhiz/mlcourse architecture

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

- Interactive diagram: https://gitdiagram.com/jswhiz/mlcourse
- Repository: https://github.com/jswhiz/mlcourse

## Overview

This repository is a ten-topic machine-learning course: learners follow course concepts through executable notebook practice and preserve reusable understanding in Russian Obsidian notes. Each topic has its own notebook collection and corresponding notes. The optional Obsidian integration safely synchronizes notes in both directions, with shared change planning and conflict handling. The graph captures the documented learning flow and the sampled sync calls; individual notebook internals were not inspected.

Main entry points: [`README.md`](https://github.com/jswhiz/mlcourse/blob/main/README.md) (Course map), [`obsidian/01 - Topics`](https://github.com/jswhiz/mlcourse/tree/main/obsidian/01%20-%20Topics) (Topic notes), [`scripts/sync_obsidian.py`](https://github.com/jswhiz/mlcourse/blob/main/scripts/sync_obsidian.py) (Repository-to-vault sync), [`scripts/push_obsidian.py`](https://github.com/jswhiz/mlcourse/blob/main/scripts/push_obsidian.py) (Vault-to-repository push)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_curriculum["Course curriculum"]
  node_course["Course map<br/>[README.md]"]
  node_index["Course index<br/>[ML Course.md]"]
end

subgraph group_practice["Notebook practice"]
  node_topic01["Pandas and EDA"]
  node_topic02["Visual analysis"]
  node_topic03["Trees and kNN"]
  node_topic04["Linear models"]
  node_topic05["Ensembles"]
  node_topic06["Feature engineering"]
  node_topic07["Unsupervised learning"]
  node_topic08["Online learning"]
  node_topic09["Time series"]
  node_topic10["Gradient boosting"]
end

subgraph group_knowledge["Knowledge base"]
  node_notes["Topic notes"]
end

subgraph group_sync["Obsidian sync"]
  node_setup["Sync setup<br/>[setup_obsidian.py]"]
  node_syncer["Repository-to-vault sync<br/>[sync_obsidian.py]"]
  node_pusher["Vault-to-repository push<br/>[push_obsidian.py]"]
  node_planner["Change and conflict planner<br/>[obsidian_common.py]"]
  node_roundtrip["Round-trip pull<br/>[pull.py]"]
end

node_learner(("Learner"))
node_vault["Obsidian vault"]

node_learner -->|"follows"| node_course
node_course -->|"links practice"| node_topic01
node_course -->|"links practice"| node_topic02
node_course -->|"links practice"| node_topic03
node_course -->|"links practice"| node_topic04
node_course -->|"links practice"| node_topic05
node_course -->|"links practice"| node_topic06
node_course -->|"links practice"| node_topic07
node_course -->|"links practice"| node_topic08
node_course -->|"links practice"| node_topic09
node_course -->|"links practice"| node_topic10
node_course -->|"points to"| node_index
node_topic01 -->|"paired with"| node_notes
node_topic02 -->|"paired with"| node_notes
node_topic03 -->|"paired with"| node_notes
node_topic04 -->|"paired with"| node_notes
node_topic05 -->|"paired with"| node_notes
node_topic06 -->|"paired with"| node_notes
node_topic07 -->|"paired with"| node_notes
node_topic08 -->|"paired with"| node_notes
node_topic09 -->|"paired with"| node_notes
node_topic10 -->|"paired with"| node_notes
node_setup -->|"runs"| node_syncer
node_syncer -->|"plans changes"| node_planner
node_syncer -->|"copies notes"| node_vault
node_syncer -->|"reads notes"| node_notes
node_pusher -->|"plans changes"| node_planner
node_pusher -->|"reads edits"| node_vault
node_pusher -->|"updates repository"| node_notes
node_roundtrip -->|"runs first"| node_pusher
node_roundtrip -->|"runs after pull"| node_syncer

click node_course "https://github.com/jswhiz/mlcourse/blob/main/README.md"
click node_index "https://github.com/jswhiz/mlcourse/blob/main/obsidian/00%20-%20Index/ML%20Course.md"
click node_topic01 "https://github.com/jswhiz/mlcourse/tree/main/topic01_pandas_data_analysis"
click node_topic02 "https://github.com/jswhiz/mlcourse/tree/main/topic02_data_visualization"
click node_topic03 "https://github.com/jswhiz/mlcourse/tree/main/topic03_decision_trees_knn"
click node_topic04 "https://github.com/jswhiz/mlcourse/tree/main/topic04_linear_models"
click node_topic05 "https://github.com/jswhiz/mlcourse/tree/main/topic05_ensembles_random_forests"
click node_topic06 "https://github.com/jswhiz/mlcourse/tree/main/topic06_feature_engineering_selection"
click node_topic07 "https://github.com/jswhiz/mlcourse/tree/main/topic07_unsupervised_learning"
click node_topic08 "https://github.com/jswhiz/mlcourse/tree/main/topic08_sgd_hashing_online_learning"
click node_topic09 "https://github.com/jswhiz/mlcourse/tree/main/topic09_time_series"
click node_topic10 "https://github.com/jswhiz/mlcourse/tree/main/topic10_gradient_boosting"
click node_notes "https://github.com/jswhiz/mlcourse/tree/main/obsidian/01%20-%20Topics"
click node_setup "https://github.com/jswhiz/mlcourse/blob/main/scripts/setup_obsidian.py"
click node_syncer "https://github.com/jswhiz/mlcourse/blob/main/scripts/sync_obsidian.py"
click node_pusher "https://github.com/jswhiz/mlcourse/blob/main/scripts/push_obsidian.py"
click node_planner "https://github.com/jswhiz/mlcourse/blob/main/scripts/obsidian_common.py"
click node_roundtrip "https://github.com/jswhiz/mlcourse/blob/main/scripts/pull.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_course,node_index toneBlue
class node_topic01,node_topic02,node_topic03,node_topic04,node_topic05,node_topic06,node_topic07,node_topic08,node_topic09,node_topic10 toneAmber
class node_notes toneMint
class node_setup,node_syncer,node_pusher,node_planner,node_roundtrip toneRose
class node_learner,node_vault toneIndigo
```

## Components

### Course curriculum

- [Course map](https://github.com/jswhiz/mlcourse/blob/main/README.md): `README.md`
- [Course index](https://github.com/jswhiz/mlcourse/blob/main/obsidian/00%20-%20Index/ML%20Course.md): `obsidian/00 - Index/ML Course.md`

### Notebook practice

- [Pandas and EDA](https://github.com/jswhiz/mlcourse/tree/main/topic01_pandas_data_analysis): `topic01_pandas_data_analysis`
- [Visual analysis](https://github.com/jswhiz/mlcourse/tree/main/topic02_data_visualization): `topic02_data_visualization`
- [Trees and kNN](https://github.com/jswhiz/mlcourse/tree/main/topic03_decision_trees_knn): `topic03_decision_trees_knn`
- [Linear models](https://github.com/jswhiz/mlcourse/tree/main/topic04_linear_models): `topic04_linear_models`
- [Ensembles](https://github.com/jswhiz/mlcourse/tree/main/topic05_ensembles_random_forests): `topic05_ensembles_random_forests`
- [Feature engineering](https://github.com/jswhiz/mlcourse/tree/main/topic06_feature_engineering_selection): `topic06_feature_engineering_selection`
- [Unsupervised learning](https://github.com/jswhiz/mlcourse/tree/main/topic07_unsupervised_learning): `topic07_unsupervised_learning`
- [Online learning](https://github.com/jswhiz/mlcourse/tree/main/topic08_sgd_hashing_online_learning): `topic08_sgd_hashing_online_learning`
- [Time series](https://github.com/jswhiz/mlcourse/tree/main/topic09_time_series): `topic09_time_series`
- [Gradient boosting](https://github.com/jswhiz/mlcourse/tree/main/topic10_gradient_boosting): `topic10_gradient_boosting`

### Knowledge base

- [Topic notes](https://github.com/jswhiz/mlcourse/tree/main/obsidian/01%20-%20Topics): `obsidian/01 - Topics`

### Obsidian sync

- [Sync setup](https://github.com/jswhiz/mlcourse/blob/main/scripts/setup_obsidian.py): `scripts/setup_obsidian.py`
- [Repository-to-vault sync](https://github.com/jswhiz/mlcourse/blob/main/scripts/sync_obsidian.py): `scripts/sync_obsidian.py`
- [Vault-to-repository push](https://github.com/jswhiz/mlcourse/blob/main/scripts/push_obsidian.py): `scripts/push_obsidian.py`
- [Change and conflict planner](https://github.com/jswhiz/mlcourse/blob/main/scripts/obsidian_common.py): `scripts/obsidian_common.py`
- [Round-trip pull](https://github.com/jswhiz/mlcourse/blob/main/scripts/pull.py): `scripts/pull.py`

### Other components

- **Learner**
- **Obsidian vault**

## Connections

- Learner → Course map: follows (evidence: `README.md`)
- Course map → Pandas and EDA: links practice (evidence: `README.md`)
- Course map → Visual analysis: links practice (evidence: `README.md`)
- Course map → Trees and kNN: links practice (evidence: `README.md`)
- Course map → Linear models: links practice (evidence: `README.md`)
- Course map → Ensembles: links practice (evidence: `README.md`)
- Course map → Feature engineering: links practice (evidence: `README.md`)
- Course map → Unsupervised learning: links practice (evidence: `README.md`)
- Course map → Online learning: links practice (evidence: `README.md`)
- Course map → Time series: links practice (evidence: `README.md`)
- Course map → Gradient boosting: links practice (evidence: `README.md`)
- Course map → Course index: points to (evidence: `README.md`)
- Pandas and EDA → Topic notes: paired with (evidence: `README.md`)
- Visual analysis → Topic notes: paired with (evidence: `README.md`)
- Trees and kNN → Topic notes: paired with (evidence: `README.md`)
- Linear models → Topic notes: paired with (evidence: `README.md`)
- Ensembles → Topic notes: paired with (evidence: `README.md`)
- Feature engineering → Topic notes: paired with (evidence: `README.md`)
- Unsupervised learning → Topic notes: paired with (evidence: `README.md`)
- Online learning → Topic notes: paired with (evidence: `README.md`)
- Time series → Topic notes: paired with (evidence: `README.md`)
- Gradient boosting → Topic notes: paired with (evidence: `README.md`)
- Sync setup → Repository-to-vault sync: runs (evidence: `scripts/setup_obsidian.py`)
- Repository-to-vault sync → Change and conflict planner: plans changes (evidence: `scripts/sync_obsidian.py`)
- Repository-to-vault sync → Obsidian vault: copies notes (evidence: `scripts/sync_obsidian.py`)
- Repository-to-vault sync → Topic notes: reads notes (evidence: `scripts/sync_obsidian.py`)
- Vault-to-repository push → Change and conflict planner: plans changes (evidence: `scripts/push_obsidian.py`)
- Vault-to-repository push → Obsidian vault: reads edits (evidence: `scripts/push_obsidian.py`)
- Vault-to-repository push → Topic notes: updates repository (evidence: `scripts/push_obsidian.py`)
- Round-trip pull → Vault-to-repository push: runs first (evidence: `scripts/pull.py`)
- Round-trip pull → Repository-to-vault sync: runs after pull (evidence: `scripts/pull.py`)
