sacrecomet 0.1.0

Tool to guide you through reporting the use of COMET for machine translation evaluation.

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 if you wish to add models/functionality.

Changelog

• v0.1.0 (30 October 2024):
  • Add list command to list available models
  • Add references usage to the SacreCOMET usage.
  • Deprecate sacrecomet cite model_name positional model name specification. Citations now have to explicitly use the --model argument.
• v0.0.1 (7 August 2024)
  • First release