Skip to content

Add CONTRIBUTING.md#293

Merged
lvwerra merged 4 commits into
mainfrom
hn-contributing-md
Sep 22, 2022
Merged

Add CONTRIBUTING.md#293
lvwerra merged 4 commits into
mainfrom
hn-contributing-md

Conversation

@mathemakitten

Copy link
Copy Markdown
Contributor

Adapted from the transformers and datasets versions; the main changes are in the Do you want to implement a new metric? section which is specific to evaluate.

@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Sep 20, 2022

Copy link
Copy Markdown

The documentation is not available anymore as the PR was closed or merged.

@lvwerra lvwerra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @mathemakitten, looks great! Just one comment about community/canonical metrics.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
less than 30s;
* Provide the *full* traceback if an exception is raised.

### Do you want to implement a new metric?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we should probably explain a bit the difference between canonical and community metric here since it is cause for confusion sometimes.

  • Canonical: well established metrics
  • Community: new or custom metrics

Similarly we could state above (did you find a bug) that if it's a community metric one can create a PR/issue right on the repository.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good call, please see changes :)

@lvwerra lvwerra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, thank you!

@lvwerra
lvwerra merged commit 8044867 into main Sep 22, 2022
@lvwerra
lvwerra deleted the hn-contributing-md branch September 22, 2022 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants