# Features — object_detection_py

Evidence date: 2026-10-08. Revision: `main` `b53f138` (2024-03-26, Dirk, "update readme").

The source repository does not list features. Status below is from `readme.md`, the git tree, and git history. Planned features written as a roadmap: **none found**. The commented training lines are the only future-looking text.

## Current features (main)

| Feature | What it does | Evidence | Status |
|---|---|---|---|
| Setup notes | conda env, proto compile, `pip install .`, numpy | `readme.md` | Documented. No env file or package metadata in this repo |
| Pinned models tree | Records upstream commit `505c718` at `tf2/models` | `git ls-tree` mode `160000` | Implemented as a gitlink. URL not recorded. Checkout stays empty without a URL |
| Model-builder test command | Names `builders/model_builder_tf2_test.py` | `readme.md` | Documented command. Test file is on the pinned upstream tree, not in this repo. No recorded result |
| wget install | `pip install wget` | `readme.md` | Documented. Download target **Unknown** |
| Image inference command | `detect_from_image.py` with SSD MobileNet V2 320 COCO17 saved model, MSCOCO label map, `.\images` | `readme.md` | Documented command. Script, weights, and images are not in git |
| LabelImg | `pip install labelimg` and `labelimg.exe` | `readme.md` | Documented. Tool is not vendored |
| XML to CSV | `python xml_to_csv.py` with no arguments | `readme.md` | Documented command. Script is not in git |
| Ignore template | Ignores bytecode, logs, IDE files, executables, and common large media | `.gitignore` | Implemented. Stock Bitbucket example from `3eaa9eb` |

## Completed, from git history

| When | Commit | What landed |
|---|---|---|
| 2024-03-19 | `3eaa9eb` | `.gitignore` only. Author Jaco Brits |
| 2024-03-22 | `c496ae6` | `tf2/models` gitlink. Author Dirk |
| 2024-03-22 | `0d91c62` | Full `readme.md`, including inference, labelling, and commented training. Author Dirk |
| 2024-03-26 | `b53f138` | Commented `model_main_tf2.py` line rewritten with `--pipeline_config_path` and `--model_dir=training`. Author Dirk |

No release tag marks any of these as a completed product.

## In development

No branch other than `main`. No unmerged work was visible at `origin` on 2026-10-08.

The commented block is the only sign of unfinished work:

- `generate_tfrecord.py` for `images/test` → `test.record` and `images/train` → `train.record`
- `model_main_tf2.py` with `ssd_efficientdet_d0_512x512_coco17_tpu-8.config` and `--model_dir=training`

Provenance: **Documented** as comments. Treat as **Planned** only if a human confirms the comments are still intended. They are not enabled instructions.

## Changed behaviour still visible in the notes

`b53f138` is a one-line change. Before it, the commented training invocation was truncated and misspelled (`pipeline_config\-psth`, `--model_dir=traini`). After it, the same commented line uses `--pipeline_config_path` and `--model_dir=training`. Behaviour of a running trainer did not change in this repository, because the line never became an active command and this repository never contained the trainer.

## Deprecated or unused

Nothing in git is marked deprecated.

These names appear only as commands and are unused as files in this tree:

- `use_protobuff.py`
- `detect_from_image.py`
- `xml_to_csv.py`
- `generate_tfrecord.py`
- `ssd_mobilenet_v2_320x320_coco17_tpu-8\saved_model`
- `ssd_efficientdet_d0_512x512_coco17_tpu-8.config`
- `images/`, `images/train`, `images/test`, `test.record`, `train.record`, `training/`

`model_main_tf2.py`, `builders/model_builder_tf2_test.py`, and `data/mscoco_label_map.pbtxt` are absent here and present under `research/object_detection/` on `tensorflow/models` commit `505c718`. Provenance of that presence: checked on GitHub on 2026-10-08. The gitlink does not vendor those files into this repository's blobs.

## Not features of this repository

- A SonarQube project. The 2026-09-28 scan listed `sonar-project.properties` and `sonarqube_scan.bat`. They are not in git. Provenance: **Unknown**.
- Serving, a camera pipeline, a web UI, an API, accounts, or a deployed model.
- Evaluation metrics, a class list, or a dataset card.
- Tests, lint, or CI owned by this repo.
- The TensorFlow Object Detection API source. It is referenced by the gitlink and by readme paths. It is not copied into this history.