[ShrimpCryptid]

Problem

Renamed methods and classes to remove references to "Colorizer", in line with the new repo + package rename. Backwards-compatibility was kept with old methods and class names, with deprecation warnings.

Once this and #112 are merged, I'll cut a new major release (v2.0.0) for the project.

Estimated review size: small, 15 minutes

Solution

• Renamed convert_colorizer_data() to convert_tfe_data().
• Renamed ColorizerMetadata to DatasetMetadata.
• Renamed ColorizerDatasetWriter to TfeDatasetWriter.
• Added backwards-compatibility with existing methods + classes.
• Added migration guide from v1 to v2.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Keyfiles (delete if not relevant):

1. tfe_data/converter.py
2. tfe_data/types.py
3. documentation/MIGRATION.md

[Copilot]

🟡 Changes recommended

Undeclared runtime dependencies, broken legacy deserialization, and invalid documentation references undermine the intended compatibility migration.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Aligns public APIs and documentation with the renamed TFE package while retaining deprecated compatibility aliases.

Changes:

• Renames converter, metadata, and writer APIs.
• Adds deprecated legacy wrappers and aliases.
• Updates tests, examples, and migration documentation.

File summaries

File	Description
tfe_data/writer.py	Renames the dataset writer and adds its legacy alias.
tfe_data/utils.py	Updates metadata type references.
tfe_data/types.py	Renames dataset metadata and adds its legacy alias.
tfe_data/converter.py	Renames conversion APIs and adds a compatibility wrapper.
tests/test_writer.py	Migrates writer tests to new names.
tests/test_types.py	Migrates metadata tests.
tests/test_converter.py	Migrates converter tests.
README.md	Updates the conversion example.
documentation/MIGRATION.md	Adds v1-to-v2 migration instructions.
documentation/getting_started_guide/GETTING_STARTED.ipynb	Updates tutorial API references.
documentation/DATA_FORMAT.md	Updates writer and metadata examples.
documentation/bin/example_scripts/getting_started_guide.py	Updates example imports and calls.
documentation/bin/example_scripts/check_conversion_api.py	Updates the conversion check script.

Review details

• Files reviewed: 11/13 changed files
• Comments generated: 4
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.