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

Rename mnist_openfl to mnist_fl #40

Merged
merged 2 commits into from
Jan 21, 2022

Conversation

danieljanes
Copy link
Contributor

Summary

This PR renames the MLCube example mnist_openfl to mnist_fl.

Background

As discussed previously with @msheller and others, the intent of this code example is to show how MLCube can be used with different FL frameworks. We are working towards providing MLCube support in Flower (https://flower.dev, PR: adap/flower#779), but we received feedback from early adopters who were confused by the naming when we pointed them at the mlcube_examples repo. The renaming will hopefully help users to understand that the approach presented is framework-agnostic.

Being a first-time contributor to MLCube, is there anything else I should update?

@github-actions
Copy link

github-actions bot commented Jan 14, 2022

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@danieljanes
Copy link
Contributor Author

Given that #33 is already merged, I've also updated the setup instruction in mnist_fl/pytorch/README.md and mnist_fl/tensorflow/README.md.

@msheller
Copy link

+1 to this.

At some point, it would be good for us to formalize this mlcube interface somehow, rather than having to point folks to a particular example mlcube.

@danieljanes
Copy link
Contributor Author

At some point, it would be good for us to formalize this mlcube interface somehow, rather than having to point folks to a particular example mlcube.

Fully agree. Where should this spec live? My first guess would be the MLCube repo/docs, but there might be a better place for it. I've created an issue to follow up on this: mlcommons/mlcube#222

@danieljanes
Copy link
Contributor Author

@sergey-serebryakov @davidjurado friendly ping (since you're the two most recent contributors here), is there anything I can do to help move this forward?

Copy link

@bitfort bitfort left a comment

Choose a reason for hiding this comment

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

Thanks!

@bitfort bitfort merged commit 5f4a483 into mlcommons:master Jan 21, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Jan 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants