修改文档结构,使datasets内容在Get Started部分更突出#156
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! 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! 此拉取请求旨在优化文档结构,以提高数据集相关内容的可见性。通过将“数据集准备指南”直接整合到“快速入门”部分,新用户可以更便捷地找到并理解如何为 AISBench Benchmark Tool 准备和使用数据集,从而简化其初始设置流程。 Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
docs/source_en/index.rst
Outdated
|
|
||
| * For users who want to use AISBench Benchmark Tool, it is recommended to first read the :doc:`Installation Guide <get_started/install>` to ensure correct environment configuration. | ||
| * The :doc:`Quick Start <get_started/quick_start>` provided in this tutorial will guide you through basic accuracy evaluation configuration and execution. | ||
| * The :doc:`Dataset Preparation Guide <base_tutorials/all_params/datasets>` will help you understand the supported datasets and how to prepare them for evaluation. |
There was a problem hiding this comment.
为了使文档结构更加清晰和一致,建议将 datasets.md 文件从 base_tutorials/all_params/ 移动到 get_started/ 目录下。这样,文件的物理位置将与其在导航中的位置(“Get Started”部分)保持一致,从而提高可维护性。
这需要以下步骤:
- 将
docs/source_en/base_tutorials/all_params/datasets.md移动到docs/source_en/get_started/datasets.md。 - 相应地更新此处的路径。
- 同时,请记得将第 35 行
toctree中的路径base_tutorials/all_params/datasets更新为get_started/datasets。
| * The :doc:`Dataset Preparation Guide <base_tutorials/all_params/datasets>` will help you understand the supported datasets and how to prepare them for evaluation. | |
| * The :doc:`Dataset Preparation Guide <get_started/datasets>` will help you understand the supported datasets and how to prepare them for evaluation. |
There was a problem hiding this comment.
[review]为了使文档结构更加清晰和一致,建议将 datasets.md 文件从 base_tutorials/all_params/ 移动到 get_started/ 目录下。这样,文件的物理位置将与其在导航中的位置(“Get Started”部分)保持一致,从而提高可维护性。
建议:
将 docs/source_en/base_tutorials/all_params/datasets.md 移动到 docs/source_en/get_started/datasets.md。
相应地更新此处的路径。
同时,请记得将第 35 行 toctree 中的路径 base_tutorials/all_params/datasets 更新为 get_started/datasets。
docs/source_zh_cn/index.rst
Outdated
|
|
||
| * 对于想要使用 AISBench 评测工具的用户,建议先阅读 :doc:`安装指南 <get_started/install>`,确保环境配置正确。 | ||
| * 本教程提供的 :doc:`快速入门 <get_started/quick_start>` 将引导你完成基本的精度评测配置和运行。 | ||
| * :doc:`数据集准备指南 <base_tutorials/all_params/datasets>` 将帮助你了解支持的数据集及其准备方法。 |
There was a problem hiding this comment.
为了使文档结构更加清晰和一致,建议将 datasets.md 文件从 base_tutorials/all_params/ 移动到 get_started/ 目录下。这样,文件的物理位置将与其在导航中的位置(“开始你的第一步”部分)保持一致,从而提高可维护性。
这需要以下步骤:
- 将
docs/source_zh_cn/base_tutorials/all_params/datasets.md移动到docs/source_zh_cn/get_started/datasets.md。 - 相应地更新此处的路径。
- 同时,请记得将第 35 行
toctree中的路径base_tutorials/all_params/datasets更新为get_started/datasets。
| * :doc:`数据集准备指南 <base_tutorials/all_params/datasets>` 将帮助你了解支持的数据集及其准备方法。 | |
| * :doc:`数据集准备指南 <get_started/datasets>` 将帮助你了解支持的数据集及其准备方法。 |
|
/gemini review |
docs/source_en/faqs/faq.md
Outdated
|
|
||
| **Recommended Solutions:** | ||
| Refer to the AISBench community’s [Dataset Preparation Guide](../base_tutorials/all_params/datasets.md#) to complete dataset preparation. | ||
| Refer to the AISBench community’s [Dataset Preparation Guide](../get_started/datasets.md#) to complete dataset preparation. |
There was a problem hiding this comment.
链接 ../get_started/datasets.md# 末尾的 # 是多余的,建议移除以保持链接简洁。虽然它能正常工作,但移除后链接更清晰。
| Refer to the AISBench community’s [Dataset Preparation Guide](../get_started/datasets.md#) to complete dataset preparation. | |
| Refer to the AISBench community’s [Dataset Preparation Guide](../get_started/datasets.md) to complete dataset preparation. |
There was a problem hiding this comment.
[review]链接 ../get_started/datasets.md# 末尾的 # 是多余的,建议移除以保持链接简洁。虽然它能正常工作,但移除后链接更清晰。
a8577ff to
20ffdc3
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
本次 PR 对文档结构进行了调整,将数据集准备指南 (datasets.md) 从 base_tutorials/all_params 目录移动到了 get_started 目录,使其在“快速入门”部分更加突出。为此,PR 中包含了对多个文档文件的修改:重命名了 datasets.md 文件,更新了 index.rst 以反映新的目录结构,并修正了所有指向旧路径的链接。此外,移动后的 datasets.md 文件内部的相对链接也已相应更新。经过审查,所有文件路径和链接的修改均正确无误,未发现任何问题。这次重构有助于改善文档的可读性和导航性。
Thanks for your contribution; we appreciate it a lot. The following instructions will make your pull request healthier and help you get feedback more easily. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
感谢您的贡献,我们非常重视。以下说明将使您的拉取请求更健康,更易于获得反馈。如果您不理解某些项目,请不要担心,只需提交拉取请求并从维护人员那里寻求帮助即可。
PR Type / PR类型
Related Issue | 关联 Issue
Fixes #(issue ID / issue 编号) / Relates to #(issue ID / issue 编号)
🔍 Motivation / 变更动机
修改文档结构,使datasets内容在Get Started部分更突出
📝 Modification / 修改内容
修改文档结构,使datasets内容在Get Started部分更突出
📐 Associated Test Results / 关联测试结果
✅ Checklist / 检查列表
Before PR:
After PR:
👥 Collaboration Info / 协作信息
🌟 Useful CI Command / 实用的CI命令
/gemini review/gemini summary/gemini help/readthedocs build