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

Guide for adding new tasks #2

Open
malteos opened this issue Jun 27, 2022 · 0 comments
Open

Guide for adding new tasks #2

malteos opened this issue Jun 27, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@malteos
Copy link

malteos commented Jun 27, 2022

  1. Check whether your task is already present in the framework.
  2. Create a new GitHub Issue for your task: https://github.com/OpenGPTX/lm-evaluation-harness/issues
  3. Fetch recent changes from GitHub git fetch origin.
  4. Create a new branch based on the master branch (git checkout origin/master), Name it according to the task that you will contribute. (git checkout -b <your_name>).
  5. Try to reuse code from existing similar tasks in the framework. Otherwise, make use of existing datasets and metrics by HuggingFace. For more information about creating new tasks in our framework, see the task guide
  6. Verify that your scores align with the scores reported in the literature
  7. Run the pre-commit hooks (see below)
  8. Commit and push only the task-relevant changes (lm_eval/tasks/__init__.py and lm_eval/tasks/<your task>.py) to a remote branch (git push origin <your branch>), create a pull request.
  9. Close the issue for your task and, if necessary, delete the old branch in your fork.

Run tests before commit

# dependecy pre-commit
pip install pre-commit>=2.2.0

# install hooks
pre-commit install

# run hooks
pre-commit run --show-diff-on-failure --color=always --all-files
@malteos malteos added the documentation Improvements or additions to documentation label Jun 27, 2022
sasaadi pushed a commit that referenced this issue Aug 25, 2022
Updated the requests so that its easier to understand.
sasaadi pushed a commit that referenced this issue Aug 25, 2022
Pulling eval harness updates
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

No branches or pull requests

1 participant