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

Add API example and doc #44

Merged
merged 8 commits into from
Oct 20, 2022
Merged

Add API example and doc #44

merged 8 commits into from
Oct 20, 2022

Conversation

neubig
Copy link
Collaborator

@neubig neubig commented Oct 18, 2022 •
edited
Loading

This PR

  1. adds an example of programmatic usage and documentation (Fixes Add documentation of programmatic usage #18)
  2. prints out evaluation scores upon evaluation (Fixes Re-think upload_system as evaluate_system #16)
  3. adds links to the nice file format doc by @qjiang002 (Fixes Documentation of file format for tasks #24 although some minor formats are not supported, and the doc could be made more explicit going forward)

@neubig neubig mentioned this pull request Oct 18, 2022
Closed
@neubig neubig requested a review from pfliu-nlp October 18, 2022 18:36
@neubig neubig mentioned this pull request Oct 18, 2022
Merged
pfliu-nlp
pfliu-nlp reviewed Oct 19, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
OscarWang114
OscarWang114 requested changes Oct 19, 2022
View reviewed changes
Copy link
Contributor

@OscarWang114 OscarWang114 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I left 2 small suggestions that should be easy to fix and 1 discussion.

README.md Show resolved Hide resolved
docs/cli.md Outdated Show resolved Hide resolved
docs/development.md Show resolved Hide resolved
pfliu-nlp
pfliu-nlp reviewed Oct 19, 2022
View reviewed changes
README.md Show resolved Hide resolved
pfliu-nlp
pfliu-nlp approved these changes Oct 19, 2022
View reviewed changes
Copy link
Collaborator

@pfliu-nlp pfliu-nlp left a comment

Choose a reason for hiding this comment

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

looks very NICE!

@neubig neubig mentioned this pull request Oct 20, 2022
Open
2 tasks
OscarWang114
OscarWang114 approved these changes Oct 20, 2022
View reviewed changes
Copy link
Contributor

@OscarWang114 OscarWang114 left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM

@neubig neubig merged commit 47edcc2 into main Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pfliu-nlp pfliu-nlp pfliu-nlp approved these changes

@OscarWang114 OscarWang114 OscarWang114 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@neubig @OscarWang114 @pfliu-nlp