Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add acknowledge section #103

Merged
merged 1 commit into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ For details on the data format and the list of supported data, please check [DAT
- [Formatting and Linting with ruff](#formatting-and-linting-with-ruff)
- [How to Release to PyPI](#how-to-release-to-pypi)
- [How to Update the Website](#how-to-update-the-website)
- [Acknowledgements](#acknowledgements)

## Environment Setup

Expand Down Expand Up @@ -91,7 +92,7 @@ If you want to run an evaluation on a new inference method or a new model, creat
For example, if you want to evaluate the `llava-hf/llava-1.5-7b-hf` model on the japanese-heron-bench task, run the following command:

```bash
uv sync --group normal
uv sync --group normal
uv run --group normal python examples/sample.py \
--model_id llava-hf/llava-1.5-7b-hf \
--task_id japanese-heron-bench \
Expand Down Expand Up @@ -172,6 +173,7 @@ If you add a new group, don’t forget to configure [conflict](https://docs.astr

## License

This repository is licensed under the Apache-2.0 License.
For the licenses of each evaluation dataset, please see [DATASET.md](./DATASET.md).

## Contribution
Expand Down Expand Up @@ -205,11 +207,19 @@ uv run ruff check --fix src
```

### How to Release to PyPI

```
git tag -a v0.x.x -m "version 0.x.x"
git push origin --tags
```
Or you can manually create a new release on GitHub.


### How to Update the Website
Please refer to [github_pages/README.md](./github_pages/README.md).

## Acknowledgements
- [Heron](https://github.com/turingmotors/heron): We refer to the Heron code for the evaluation of the Japanese Heron Bench task.
- [lmms-eval](https://github.com/EvolvingLMMs-Lab/lmms-eval): We refer to the lmms-eval code for the evaluation of the JMMMU and MMMU tasks.

We also thank the developers of the evaluation datasets for their hard work.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ dependencies = [
"scipy>=1.15.1",
]
readme = "README.md"
license = "Apache-2.0"
requires-python = ">= 3.12.1"

dynamic = [
Expand Down