# SacreCOMET
The tool has two functionalities.
First, it creates a signature with your setup and COMET model:
```
pip install sacrecomet
# Without anything will try to detect the local environment and will
# ask you questions about which COMET model you used.
# Example output: Python3.11.8|Comet2.2.2|fp32|unite-mup
sacrecomet
# Arguments can also be specified non-interactively:
sacrecomet --model unite-mup --prec fp32
```
The other functionality is to find specific citations for COMET models that you're using:
```
sacrecomet cite Unbabel/xcomet-xl
https://arxiv.org/abs/2310.10482
@misc{guerreiro2023xcomet,
title={xCOMET: Transparent Machine Translation Evaluation through Fine-grained Error Detection},
...
```
Please open an issue/pull request in the [repository](https://github.com/PinzhenChen/sacreCOMET) if you wish to add models/functionality.
<!--
Notes for maintainers:
cd python-tool
# newer version might not work
pip install 'build<0.10.0' twine
python3 -m build
# first tets
twine check dist/*
twine upload -r testpypi dist/*
# live
twine upload dist/* -u __token__
# user __token__ as username and the API token generated online
-->
Raw data
{
"_id": null,
"home_page": null,
"name": "sacrecomet",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "machine-translation, evaluation, quality-estimaation",
"author": null,
"author_email": "Vil\u00e9m Zouhar <vzouhar@ethz.ch>, Tsz Kin Lam <tlam@ed.ac.uk>, Pinzhen Chen <pinzhen.chen@ed.ac.uk>, Nikita Moghe <nikita.moghe@ed.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/ea/29/4c9af8d7a8ed5df2cb3e6be73a51f16e423ece2136b7563c00449765407b/sacrecomet-0.0.1.tar.gz",
"platform": null,
"description": "# SacreCOMET\n\nThe tool has two functionalities.\nFirst, it creates a signature with your setup and COMET model:\n\n```\npip install sacrecomet\n\n# Without anything will try to detect the local environment and will\n# ask you questions about which COMET model you used.\n# Example output: Python3.11.8|Comet2.2.2|fp32|unite-mup\n\nsacrecomet \n\n# Arguments can also be specified non-interactively:\n\nsacrecomet --model unite-mup --prec fp32\n```\n\nThe other functionality is to find specific citations for COMET models that you're using:\n\n```\nsacrecomet cite Unbabel/xcomet-xl\n\nhttps://arxiv.org/abs/2310.10482\n@misc{guerreiro2023xcomet,\n title={xCOMET: Transparent Machine Translation Evaluation through Fine-grained Error Detection}, \n ...\n```\n\nPlease open an issue/pull request in the [repository](https://github.com/PinzhenChen/sacreCOMET) if you wish to add models/functionality.\n\n\n<!-- \nNotes for maintainers:\n\ncd python-tool\n# newer version might not work\npip install 'build<0.10.0' twine\n\n\npython3 -m build\n\n# first tets\ntwine check dist/*\ntwine upload -r testpypi dist/*\n\n# live\ntwine upload dist/* -u __token__\n# user __token__ as username and the API token generated online\n-->\n",
"bugtrack_url": null,
"license": null,
"summary": "Tool to guide you through reporting the use of COMET for machine translation evaluation.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/PinzhenChen/sacreCOMET"
},
"split_keywords": [
"machine-translation",
" evaluation",
" quality-estimaation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b42f884d88734f6616fb70ce4f911fa8e17d93bd0084881da9751735bace87e9",
"md5": "d3ab3c32c4dd5e7e8b0b86edb4f0c02a",
"sha256": "7170687710ea3b1607954acf8bb88290053fb4e1d066e5cf3ab19b974e308687"
},
"downloads": -1,
"filename": "sacrecomet-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3ab3c32c4dd5e7e8b0b86edb4f0c02a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9477,
"upload_time": "2024-08-07T10:41:47",
"upload_time_iso_8601": "2024-08-07T10:41:47.691922Z",
"url": "https://files.pythonhosted.org/packages/b4/2f/884d88734f6616fb70ce4f911fa8e17d93bd0084881da9751735bace87e9/sacrecomet-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea294c9af8d7a8ed5df2cb3e6be73a51f16e423ece2136b7563c00449765407b",
"md5": "a667fa1abce39b59faab0d59847db73b",
"sha256": "ab1eea7e34784c679dc7a0354640d0f77947dc937a5a531244a116b69c0de688"
},
"downloads": -1,
"filename": "sacrecomet-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a667fa1abce39b59faab0d59847db73b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9859,
"upload_time": "2024-08-07T10:41:49",
"upload_time_iso_8601": "2024-08-07T10:41:49.163892Z",
"url": "https://files.pythonhosted.org/packages/ea/29/4c9af8d7a8ed5df2cb3e6be73a51f16e423ece2136b7563c00449765407b/sacrecomet-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-07 10:41:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PinzhenChen",
"github_project": "sacreCOMET",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sacrecomet"
}
JSON
