Fix/ngram counter

[shenxiangzhuang]

Summary by CodeRabbit

• New Features

  • Enhanced BLEU score computation with clearer variable names and improved formula accuracy.
  • Introduced comprehensive testing for BLEU scores and tokenizer functionality across different libraries and implementations.
  • Added pytest-sugar for enhanced visual feedback during testing.

• Bug Fixes

  • Adjusted ngram generation logic to ensure correct grouping and counting, enhancing translation evaluation accuracy.

• Refactor

  • Improved readability and consistency in naming conventions across various functions and parameters.

• Tests

  • Added new test cases and fixtures to support robust validation of translation tools and utilities.

[coderabbitai]

Warning

Rate Limit Exceeded

@shenxiangzhuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 50 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 5c7c23e and aa5dcbe.

Walkthrough

This update enhances the BLEU score calculation pipeline by refining the code structure and adding testing capabilities. Changes include renaming variables for clarity, adjusting ngram logic, integrating pytest for various platforms, and improving tokenization and documentation. These modifications aim to boost accuracy, maintainability, and readability of the code.

Changes

File Path	Change Summary
.github/workflows/CI.yml, tests/...	Updated CI workflows and added various test files for comprehensive testing across platforms.
pyproject.toml	Added pytest-sugar to optional dependencies for enhanced test output.
src/bleu.rs, src/lib.rs	Renamed variables and parameters for clarity in BLEU score calculations.
src/ngram.rs, src/tokenizer.rs	Adjusted ngram logic and tokenizer formatting for better functionality and readability.
tests/py_bleu.py, tests/py_token.py	Enhanced and cleaned up test files for BLEU score and tokenization.

Possibly related issues

• Add Tokenizer before BLEU Calculation #7: The improvements to tokenization and BLEU score calculation could address this issue's objectives by ensuring the tokenizer is well-integrated and does not impact BLEU score accuracy.

Poem

🐰 A CodeRabbit's Ode to Code 🌟

In the den where code lines weave,
A rabbit hops with tricks up sleeve.
Tokens dance and ngrams align,
Tests pass green in record time.
Cheers to code that's clean and bright,
Push to main, then call it a night!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.