Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft migration path doc from ML Model to MLM Extension #19

Open
wants to merge 5 commits into
base: deprecate
Choose a base branch
from

Conversation

rbavery
Copy link
Collaborator

@rbavery rbavery commented Aug 7, 2024

This adds a migration doc that describes similarities and differences in capabilities between the ML Model Extension and the Machine Learning Model Extension. It also highlights how some field names have changed, enums have been expanded, and some fields have been removed. It notes that the ML Model Extension is not maintained and it's primary public facing implementation is deprecated.

If this is approved and merged I think we should then approve and merge #16. Once the repo ownership of https://github.com/crim-ca/mlm-extension/tree/main is changed to STAC Extensions, then I can update the links in this migration document to point to the new repo url.

I think I will need assistance from the STAC Extension maintainers to make a request to CRIM to initiate a move of the entire repo since we want to preserve stars, github history, issues, etc. cc @fmigneault

Copy link
Member

@gadomski gadomski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a strongly held opinion, but would we make lives easier on ourselves if we migrated the mlm-extension repo to the stac-extensions organization first, then updated the text here? To me it feels funny to merge this PR knowing that we'll have to go through and update a bunch of URLs shortly thereafter.

Another nice-to-have would be a migration script that we could point folks to ... maybe as part of the stac-model repo?

Other than those two points, LGTM.

@rbavery
Copy link
Collaborator Author

rbavery commented Aug 14, 2024

Thanks for the comments @gadomski

Unfortunately I don't have the bandwidth to provide a migration script right now. There might be some nontrivial decisions to handle in the migration. But I'm happy to review and work with others on PRs. stac-model is maintained alongside the spec here https://github.com/crim-ca/mlm-extension/blob/main/README_STAC_MODEL.md

I'm happy to merge this PR after the migration. If STAC maintainers initiate that @fmigneault can you accept the invite to do so for the https://github.com/crim-ca org? I'm not sure how full repo migrations work and who initiates.

@gadomski
Copy link
Member

I'm not sure how full repo migrations work and who initiates.

I've done it a few times (for https://github.com/stactools-packages/) but it's been a minute. I believe @fmigneault can go to https://github.com/crim-ca/mlm-extension/transfer and then choose stac-extensions as the target organization — I'd try that first, at least.

MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
@fmigneault
Copy link
Collaborator

@rbavery @gadomski
I believe migration would be the right way to handle the transfer to preserve stars, issues, etc. I think GitHub even defines some redirects for people using the old links (but don't quote me on that 😅). This would also allow CRIM to re-fork the stac-extensions repo to indicate appropriate redirects and maintain a mirror of the old schemas (https://crim-ca.github.io/mlm-extension/), since those are employed by existing STAC deployments.

However, once this is done (and that I get the approvals from CRIM higher ups), I will need from an admin of stac-extensions to provide the necessary permissions to adjust the settings. The migration page displays a warning that all configured protection rules will be removed during the transfer. I would like to re-enable those, and make sure @rbavery, @languith and @fmigneault (at least) have the necessary access to manage the repository.

@gadomski
Copy link
Member

I will need from an admin of stac-extensions to provide the necessary permissions to adjust the settings.

No problem at all ... when migrated, I'll be able to add you as a maintainer of the repo so you can PR (or just YOLO change) anything as needed. You will also be able to add others as needed.

MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
MIGRATION_TO_MLM.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants