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

new_benchmark #346

Closed
wants to merge 13 commits into from
Closed

new_benchmark #346

wants to merge 13 commits into from

Conversation

dhw059
Copy link

@dhw059 dhw059 commented Apr 7, 2024

Matbench Pull Request Template

Thanks for making a PR to Matbench! We appreciate your contribution (like, a lot). To make things run smoothly, check out the following templates,
depending on what kind of PR you are making.

If you are making a benchmark submission (i.e., you have tried an algorithm on Matbench and want to appear on the leaderboard),
please use the template under Benchmark submissions.

If you are making changes to the core matbench code, data, or docs, please use the template under Core code/data/docs changes.

Benchmark submissions

Benchmark submissions can include a full benchmark on any of the benchmarks Matbench submits, as well as any subset of tasks within a benchmark (e.g., 3 Matbench v0.1 tasks your algorithm supports).

Brief description of your algorithm

You should a brief description of your algorithm in the pull request body. This can include any details you'd like.

Included files

If you are making a benchmark submission, please only include the submission as a folder in the /benchmarks directory with the format <benchmark_name>_<algorithm_name>. Your PR should have no other changes to the core code.
The submission should have these three required files, as indicated in the
docs:

Example

-- benchmarks
---- matbench_v0.1_my_algorithm
------ results.json.gz             # required filename
------ notebook.ipynb              # required filename
------ info.json                   # required filename

Please make sure each of these files has the information specified in the docs.

If you have other short/small files required for the notebook, please give a brief overview of what each one is used for and how to use it.

Label the pull request

Label the pull request with the new_benchmark label.

Core code/data/docs changes

Brief description of changes

Please include a brief description of the changes you are making, in bullet point format.

Tests

Indicate if your code requires new tests and whether they are included with your PR. ALL core code/data/docs changes adding new features must have new tests for them.

Closed issues or PRs

Indicate if your PR closes any currently open issues or supersedes any other currently open PRs.

Label the pull request

Label the pull request with the code or docs labels, depending on which one (or both) applies.

@JaGeo
Copy link
Member

JaGeo commented Apr 7, 2024

Hi @dhw059 ,

I just saw your pull-request and your frequent closing and opening.
Maybe, it's worth trying the git command line tools or the github app rather than the github upload. Should be much easier to solve issues.

@dhw059 dhw059 closed this Apr 7, 2024
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.

2 participants