Skip to content

Update README.md #6

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

Merged
merged 13 commits into from
Oct 7, 2024
Merged

Update README.md #6

merged 13 commits into from
Oct 7, 2024

Conversation

dsuhinin
Copy link
Collaborator

@dsuhinin dsuhinin commented Oct 1, 2024

No description provided.

Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
@nojaf
Copy link
Collaborator

nojaf commented Oct 2, 2024

I'm assuming you want to rename README_NEW.md to README.md right?

@dsuhinin
Copy link
Collaborator Author

dsuhinin commented Oct 2, 2024

I'm assuming you want to rename README_NEW.md to README.md right?

correct! I just want to keep both so it will be easier to compare. also Im waiting for feedback from Fabio.

Signed-off-by: Software Developer <[email protected]>
Copy link
Contributor

@fabiovincenzi fabiovincenzi left a comment

Choose a reason for hiding this comment

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

Tested inside a dev container, everything seems to work fine, maybe it would be nice to say somewhere that the use of a Dev Container is recommended.

Signed-off-by: Software Developer <[email protected]>
Signed-off-by: Software Developer <[email protected]>
CONTRIBUTING.md Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this technical stuff belongs in CONTRIBUTING.md, see for example: https://github.com/armadaproject/armada/blob/master/CONTRIBUTING.md

I'd suggest moving the installation to README and referring users to the configure magefile if they want more information about each step rather than recapping them here.

I do, however, love days when my job requires reading things like "install the dreaded psycho"

Copy link

@suprjinx suprjinx Oct 2, 2024

Choose a reason for hiding this comment

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

I don't think it should be in README -- this is the installation process for a developer, not the run-time user (I think).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@dave-gantenbein details could be really different. In our case since we have 2 in system, overall process looks a bit complex: to run, to test, etc. I think we will simplify it, when all the endpoints will be moved to Go MLFlow so we won't need to support much Python stuff in that case. So my vote to keep all of that in CONTRIBUTING.md and see.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is fine for now, and we can revisit it later.

What Dave is probably hinting at is that we should answer the higher-level question of how people can contribute. Adding endpoints is one way, but we also welcome other contributions such as reporting bugs, improving the onboarding experience, and adding production benchmarks to see whether this is faster than vanilla MLflow.

Overall, my two cents would be to move forward with this PR and improve things later on.

@dsuhinin dsuhinin marked this pull request as ready for review October 7, 2024 07:57
@dsuhinin dsuhinin requested a review from nojaf October 7, 2024 08:44
@dsuhinin dsuhinin merged commit 6f2a6f1 into mlflow:main Oct 7, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants