docs: update README

[e06084]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @e06084, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the clarity and completeness of the documentation for custom rule implementation across the English, Japanese, and Simplified Chinese README files. The changes aim to provide more practical and consistent code examples, making it easier for users to understand how to define and utilize custom evaluation rules within the system. This enhancement ensures that the documentation is more user-friendly and accurate, particularly for those looking to extend the system's evaluation capabilities.

Highlights

• Enhanced Custom Rule Examples: The MyCustomRule examples in all README files (English, Japanese, and Simplified Chinese) have been updated to include more practical logic for checking empty content, making them more illustrative for users implementing custom evaluation rules.
• Improved EvalDetail Consistency: The metric field has been consistently added to the EvalDetail return statements within the custom rule examples, ensuring better data structure and clarity for evaluation results.
• Refined DomainSpecificRule Examples: The DomainSpecificRule examples in the Japanese and Simplified Chinese READMEs have been significantly refactored. This includes removing the EvaluatorRuleArgs import and dynamic_config attribute, and providing a more concrete example of validation logic within the eval method.
• Documentation Link Clarification: The English README now explicitly labels certain guide links (RAG Evaluation, Hallucination Detection, Factuality Assessment) as (中文) to indicate they are Chinese versions, improving navigation for users.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides helpful updates to the README files in English, Japanese, and Chinese. The code examples for custom rules are now more illustrative and correct, particularly with the addition of the required metric parameter to EvalDetail initializations. My review includes a few minor suggestions to further improve the clarity of one of the examples for users who might copy the code.

[gemini-code-assist]

This example is a great improvement. For better clarity, since cls.metric_type is defined by the @Model.rule_register decorator which isn't visible in this snippet, consider adding a small inline comment to explain where it comes from. This will help users understand the example more easily.

Suggested change

	label=[f'{cls.metric_type}.{cls.__name__}'],
	label=[f'{cls.metric_type}.{cls.__name__}'], # metric_type is set by the @Model.rule_register decorator

[gemini-code-assist]

This example is a great improvement. For better clarity, since cls.metric_type is defined by the @Model.rule_register decorator which isn't visible in this snippet, consider adding a small inline comment to explain where it comes from. This will help users understand the example more easily.

Suggested change

	label=[f'{cls.metric_type}.{cls.__name__}'],
	label=[f'{cls.metric_type}.{cls.__name__}'], # metric_type is set by the @Model.rule_register decorator

[gemini-code-assist]

This example is a great improvement. For better clarity, since cls.metric_type is defined by the @Model.rule_register decorator which isn't visible in this snippet, consider adding a small inline comment to explain where it comes from. This will help users understand the example more easily.

Suggested change

	label=[f'{cls.metric_type}.{cls.__name__}'],
	label=[f'{cls.metric_type}.{cls.__name__}'], # metric_type is set by the @Model.rule_register decorator