Repository navigation
refactor: Update documentation to new path, renamed package to tfe_data - #112
Merged
Merged
Conversation
tfe_datatfe_data
ShrimpCryptid
commented
Sep 14, 2026
| convert_colorizer_data, | ||
| FeatureInfo, | ||
| FeatureType, | ||
| ColorizerMetadata, |
Contributor
Author
There was a problem hiding this comment.
This will get renamed to DatasetMetadata soon and the old data class will be removed.
ShrimpCryptid
added this pull request to stack #114
September 14, 2026 18:58
… additional import updates
ShrimpCryptid
force-pushed
the
refactor/update-docs
branch
from
September 14, 2026 19:12
537d36f to
ec3cf3f
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Installation instructions target an incompatible old tag, and several renamed paths remain incorrect.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Renames the Python package to tfe_data, updates repository references, and relocates the bundled TFE viewer.
Changes:
- Migrates package imports and packaging metadata.
- Updates documentation, examples, and tests.
- Includes viewer runtime assets under the renamed package.
File summaries
| File | Description |
|---|---|
tfe_data/writer.py |
Updates imports and documentation links. |
tfe_data/utils.py |
Updates imports and documentation link. |
tfe_data/types.py |
Relocates package type definitions. |
tfe_data/converter.py |
Updates package imports and examples. |
tfe_data/bin/viewer/default/index.html |
Adds bundled viewer entry page. |
tfe_data/bin/viewer/default/images/aics-logo.svg |
Adds viewer logo. |
tfe_data/bin/viewer/default/assets/webimage-DBgUwIbt.js |
Adds image decoder bundle. |
tfe_data/bin/viewer/default/assets/raw-in9isEBO.js |
Adds raw decoder bundle. |
tfe_data/bin/viewer/default/assets/pako.esm-BkaqWuDM.js |
Adds compression bundle. |
tfe_data/bin/viewer/default/assets/packbits-DDWKfGV_.js |
Adds PackBits decoder. |
tfe_data/bin/viewer/default/assets/main-EL5x51Au.css |
Adds viewer styles. |
tfe_data/bin/viewer/default/assets/lzw-_aCqfs4w.js |
Adds LZW decoder. |
tfe_data/bin/viewer/default/assets/lz4-BIGKWw27.js |
Adds LZ4 decoder. |
tfe_data/bin/viewer/default/assets/jpeg-JhJy4lL1.js |
Adds JPEG decoder. |
tfe_data/bin/viewer/default/assets/gh_routing-Ccc8RuuD.js |
Adds static-host routing. |
tfe_data/bin/viewer/default/assets/FetchTiffWorker-CfWXhx_B.js |
Adds TIFF worker bundle. |
tfe_data/bin/viewer/default/assets/deflate-Dthki0TA.js |
Adds Deflate decoder. |
tfe_data/bin/viewer/default/assets/chunk-INHXZS53-D3tQiqtZ.js |
Adds shared bundle code. |
tfe_data/bin/viewer/default/assets/basedecoder-B2c5_Eok.js |
Adds base decoder. |
tfe_data/bin/viewer/default/assets/BannerVideo-W0lKlmpc.js |
Adds banner component bundle. |
tfe_data/bin/viewer/default/assets/404-CzBSvGm8.js |
Adds redirect bundle. |
tfe_data/bin/viewer/default/404.html |
Adds viewer fallback page. |
tfe_data/bin/tfe_open.py |
Relocates the local viewer CLI. |
tfe_data/__init__.py |
Exposes the renamed package API. |
tests/test_writer.py |
Updates writer imports. |
tests/test_utils.py |
Updates utility imports. |
tests/test_types.py |
Updates type imports. |
tests/test_converter.py |
Updates converter imports and fixture path. |
README.md |
Updates package and installation instructions. |
pyproject.toml |
Renames distribution, package, URLs, and entry points. |
documentation/getting_started_guide/requirements.txt |
Renames the tutorial dependency. |
documentation/getting_started_guide/GETTING_STARTED.ipynb |
Updates tutorial paths and imports. |
documentation/DATA_FORMAT.md |
Updates package and repository references. |
documentation/bin/example_scripts/getting_started_guide.py |
Updates example imports and CLI path. |
documentation/bin/example_scripts/check_conversion_api.py |
Updates example import. |
.gitignore |
Updates the ignored viewer path. |
.bumpversion.toml |
Updates the versioned package path. |
Review details
Suppressed comments (1)
documentation/getting_started_guide/GETTING_STARTED.ipynb:580
- The repository was updated, but the source path in this link still uses the removed
colorizer_datadirectory. The link therefore returns 404 instead of opening the converter documentation.
"[`convert_colorizer_data`](https://github.com/AllenCell/tfe-data/blob/main/colorizer_data/converter.py#L390) includes detailed documentation for additional configuration options and parameters.\n",
- Files reviewed: 13/51 changed files
- Comments generated: 5
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
ascibisz
approved these changes
Sep 14, 2026
interim17
approved these changes
Sep 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
This repo has been moved from
allen-cell-animated/colorizer-datatoAllenCell/tfe-data. I've updated links to refer to the new path across our documentation and tutorials.Additionally, I also renamed the main module from
colorizer_datatotfe_data, and updated imports across the code and documentation to refer to the new paths.In a follow-up PR, I'll also be renaming a few methods, with deprecation warnings for the old methods. Together, these will both make a new major release bump of this repo.
Estimated review size: small, 5-10 minutes
Solution
colorizer_datapackage totfe_data.allen-cell-animated/colorizer-datato point toAllenCell/tfe-data.Type of change
Please delete options that are not relevant.
Steps to Verify: