Update algorithm List in README

[pan-x-c]

Description

1. Add SFT DPO into algorithm list
2. Add runtime monitoring guide for workflow developers

Checklist

Please check the following items before code is ready to be reviewed.

• Code has passed all tests
• Docstrings have been added/updated in Google Style
• Documentation has been updated
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @pan-x-c, 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 primarily updates the project's documentation to reflect recent additions to its algorithm offerings. It integrates the SFT and DPO algorithms into both English and Chinese versions of the README and Sphinx documentation, ensuring that users have up-to-date information on available functionalities. Additionally, it rectifies an outdated example link for the 'On-Policy Distillation' algorithm and adjusts the project's core dependencies by promoting matplotlib from a development-only tool to a general requirement.

Highlights

• Algorithm List Expansion: Added two new algorithms, SFT (Supervised Fine-Tuning) and DPO (Direct Preference Optimization), to the comprehensive algorithm lists in both English and Chinese READMEs and Sphinx documentation.
• Documentation Link Correction: Updated the example link for the 'On-Policy Distillation' algorithm across all documentation files, changing the path from on_policy_distill to opd_gsm8k.
• Dependency Management Update: Refactored the matplotlib dependency in pyproject.toml, moving it from a development-specific requirement to a core project dependency.

Changelog

• README.md
  • Introduced SFT (Supervised Fine-Tuning) and DPO (Direct Preference Optimization) algorithms to the main algorithm table.
  • Updated the example path for 'On-Policy Distillation' from on_policy_distill to opd_gsm8k.
• README_zh.md
  • Added SFT (Supervised Fine-Tuning) and DPO (Direct Preference Optimization) algorithms to the Chinese algorithm table.
  • Corrected the example path for 'On-Policy Distillation' to opd_gsm8k.
• docs/sphinx_doc/source/main.md
  • Integrated SFT and DPO algorithms into the English Sphinx documentation's algorithm list.
  • Modified the example path for 'On-Policy Distillation'.
• docs/sphinx_doc/source_zh/main.md
  • Included SFT and DPO algorithms in the Chinese Sphinx documentation's algorithm list.
  • Updated the example path for 'On-Policy Distillation'.
• pyproject.toml
  • Moved matplotlib from the dev dependency group to the main dependencies list, indicating it's now a core requirement.

Activity

• The pull request was created by pan-x-c.
• The description includes a checklist, but its current status is unchecked, and no further comments or reviews have been recorded.

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

The pull request updates the algorithm list in the README.md, README_zh.md, and corresponding Sphinx documentation files (docs/sphinx_doc/source/main.md, docs/sphinx_doc/source_zh/main.md). It adds entries for SFT and DPO algorithms, and updates the example path for On-Policy Distillation. Additionally, the pyproject.toml file has been modified to move matplotlib from development dependencies to core dependencies, indicating its broader usage within the project. The changes are well-formatted and maintain consistency across the documentation files, including a consistent translation update from "例子" to "示例" in the Chinese documentation.

[pan-x-c]

/gemini review

[gemini-code-assist]

Code Review

This pull request updates the documentation by adding SFT and DPO to the algorithm lists and including a new guide on runtime monitoring for workflow developers. The changes are mostly good, but I've found a few issues: several markdown files have a broken link due to a typo in the link syntax, there's a typo in the new monitoring guide, and a dependency change in pyproject.toml that needs clarification. Overall, these are straightforward documentation and dependency updates.