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.

Sign up for GitHub

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

Jump to bottom

README: A quick example to get started #329

Open
Jieran-S opened this issue Jan 6, 2025 · 2 comments
Open

README: A quick example to get started #329

Jieran-S opened this issue Jan 6, 2025 · 2 comments
Assignees
@heylf

Comments

@Jieran-S
Copy link
Member

Jieran-S commented Jan 6, 2025

This is one of the issue on README file.

Create a section on how to get started with the workflow. Give a quick example of executing the workflow using one dataset/method/metric so people can start by just copy and paste

Give documentation on each step. Make it user-friendly!

Work only on workflow_update branch.
@heylf heylf self-assigned this Jan 10, 2025
@heylf heylf mentioned this issue Jan 10, 2025
Merged
@heylf
Copy link
Contributor

heylf commented Jan 10, 2025

Ready for review

@Jieran-S
Copy link
Member Author

I've updated the consensus part of the workflow! Might be worth it to add that part into the README as well! :))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heylf heylf

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@heylf @Jieran-S