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

Add Notes for run.sh Script in README.md #46

Merged
merged 9 commits into from
Feb 14, 2025
Merged

Add Notes for run.sh Script in README.md #46

merged 9 commits into from
Feb 14, 2025

Conversation

work4cs
Copy link
Collaborator

@work4cs work4cs commented Jan 24, 2025

  • Explain in the README.md that run.sh bash is for simulating the process on the leaderboard and the participants could use it to test in the local.
  • Describe in the README.md what run.sh bash file does.

@work4cs work4cs requested a review from egrace479 January 24, 2025 22:15
@work4cs work4cs mentioned this pull request Jan 24, 2025
Copy link
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

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

I think we need some explanation that they would need to match a val set description with both images and a validation reference file. It doesn't necessarily need much more detail than that along with perhaps the couple lines of code that would show the format needed. Or do we have a sample version we could point to?

README.md Outdated Show resolved Hide resolved
@egrace479 egrace479 added the documentation Improvements or additions to documentation label Jan 24, 2025
README.md Show resolved Hide resolved
@work4cs
Copy link
Collaborator Author

work4cs commented Jan 25, 2025

I think we need some explanation that they would need to match a val set description with both images and a validation reference file. It doesn't necessarily need much more detail than that along with perhaps the couple lines of code that would show the format needed. Or do we have a sample version we could point to?

There are samples in test_scoring branch

Co-authored-by: Elizabeth Campolongo <[email protected]>
Copy link
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

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

LGTM

@work4cs
Copy link
Collaborator Author

work4cs commented Feb 13, 2025

I think we need some explanation that they would need to match a val set description with both images and a validation reference file. It doesn't necessarily need much more detail than that along with perhaps the couple lines of code that would show the format needed. Or do we have a sample version we could point to?

There are samples in test_scoring branch

Actually I suddenly remember we should put the sample reference csv and prediction txt in ./sample_result_submission/sample @egrace479

Copy link
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

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

Good addition!

@work4cs work4cs merged commit f8b65b9 into main Feb 14, 2025
@work4cs work4cs deleted the run_script branch February 14, 2025 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants