Skip to content

修改文档结构,使datasets内容在Get Started部分更突出#156

Merged
GaoHuaZhang merged 2 commits intoAISBench:masterfrom
Keithwwa:pr_mv_dataset_to_getstart
Mar 3, 2026
Merged

修改文档结构,使datasets内容在Get Started部分更突出#156
GaoHuaZhang merged 2 commits intoAISBench:masterfrom
Keithwwa:pr_mv_dataset_to_getstart

Conversation

@Keithwwa
Copy link
Collaborator

@Keithwwa Keithwwa commented Mar 3, 2026

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类型

  • Feature(功能新增)
  • Bugfix(Bug 修复)
  • Docs(文档更新)
  • CI/CD(持续集成/持续部署)
  • Refactor(代码重构)
  • Perf(性能优化)
  • Dependency(依赖项更新)
  • Test-Cases(测试用例更新)
  • Other(其他)

Related Issue | 关联 Issue
Fixes #(issue ID / issue 编号) / Relates to #(issue ID / issue 编号)

🔍 Motivation / 变更动机

修改文档结构,使datasets内容在Get Started部分更突出

📝 Modification / 修改内容

修改文档结构,使datasets内容在Get Started部分更突出

📐 Associated Test Results / 关联测试结果

image

✅ Checklist / 检查列表

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues. / 使用预提交或其他 linting 工具来修复潜在的 lint 问题。
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests. / 修复的 Bug 已完全由单元测试覆盖,导致 Bug 的情况应在单元测试中添加。
  • The modification is covered by complete unit tests. If not, please add more unit tests to ensure the correctness. / 此拉取请求中的修改已完全由单元测试覆盖。如果不是,请添加更多单元测试以确保正确性。
  • All relevant documentation (API docs, docstrings, example tutorials) has been updated to reflect these changes. / 所有相关文档(API 文档、文档字符串、示例教程)已更新以反映这些更改。

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects. / 如果此拉取请求对下游或其他相关项目有潜在影响,应在那些项目中测试此 PR。
  • CLA has been signed and all committers have signed the CLA in this PR. / CLA 已签署,且本 PR 中的所有提交者均已签署 CLA。

👥 Collaboration Info / 协作信息

  • Suggested Reviewers / 建议审核人: @xxx
  • Relevant Module Owners / 相关模块负责人: @xxx
  • Other Collaboration Notes / 其他协作说明:

🌟 Useful CI Command / 实用的CI命令

Command / 命令 Introduction / 介绍
/gemini review Performs a code review for the current pull request in its current state by Gemini. / 对当前拉取请求在当前状态下由 Gemini 执行代码审核。
/gemini summary Provides a summary of the current pull request in its current state by Gemini. / 对当前拉取请求在当前状态下由 Gemini 提供摘要。
/gemini help Displays a list of available commands of Gemini. / 显示 Gemini 可用命令的列表。
/readthedocs build Triggers a build of the documentation for the current pull request in its current state by Read the Docs. / 触发当前拉取请求在当前状态下由 Read the Docs 构建文档。

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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
  • docs/source_en/base_tutorials/all_params/index.rst
    • 从详细参数说明的目录中移除了对数据集的引用。
  • docs/source_en/index.rst
    • 在主页的“快速入门”部分新增了数据集准备指南的推荐链接。
    • 将数据集准备指南添加到了“快速入门”部分的目录中。
  • docs/source_zh_cn/base_tutorials/all_params/index.rst
    • 从详细参数说明的目录中移除了对数据集的引用。
  • docs/source_zh_cn/index.rst
    • 在主页的“快速入门”部分新增了数据集准备指南的推荐链接。
    • 将数据集准备指南添加到了“快速入门”部分的目录中。
Activity
  • 没有检测到任何活动。
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

本次 PR 旨在调整文档结构,将 datasets 相关内容在“Get Started”部分突出显示。您通过修改中英文 index.rst 文件,将数据集准备指南的链接前提,并将其从参数说明中移除,成功实现了这一目标。

我提出了一些关于文件物理路径的建议,以使文档的源文件结构与导航结构更加一致,从而提高可维护性。请查看具体的评论。


* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了使文档结构更加清晰和一致,建议将 datasets.md 文件从 base_tutorials/all_params/ 移动到 get_started/ 目录下。这样,文件的物理位置将与其在导航中的位置(“Get Started”部分)保持一致,从而提高可维护性。

这需要以下步骤:

  1. docs/source_en/base_tutorials/all_params/datasets.md 移动到 docs/source_en/get_started/datasets.md
  2. 相应地更新此处的路径。
  3. 同时,请记得将第 35 行 toctree 中的路径 base_tutorials/all_params/datasets 更新为 get_started/datasets
Suggested change
* 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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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。


* 对于想要使用 AISBench 评测工具的用户,建议先阅读 :doc:`安装指南 <get_started/install>`,确保环境配置正确。
* 本教程提供的 :doc:`快速入门 <get_started/quick_start>` 将引导你完成基本的精度评测配置和运行。
* :doc:`数据集准备指南 <base_tutorials/all_params/datasets>` 将帮助你了解支持的数据集及其准备方法。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

为了使文档结构更加清晰和一致,建议将 datasets.md 文件从 base_tutorials/all_params/ 移动到 get_started/ 目录下。这样,文件的物理位置将与其在导航中的位置(“开始你的第一步”部分)保持一致,从而提高可维护性。

这需要以下步骤:

  1. docs/source_zh_cn/base_tutorials/all_params/datasets.md 移动到 docs/source_zh_cn/get_started/datasets.md
  2. 相应地更新此处的路径。
  3. 同时,请记得将第 35 行 toctree 中的路径 base_tutorials/all_params/datasets 更新为 get_started/datasets
Suggested change
* :doc:`数据集准备指南 <base_tutorials/all_params/datasets>` 将帮助你了解支持的数据集及其准备方法。
* :doc:`数据集准备指南 <get_started/datasets>` 将帮助你了解支持的数据集及其准备方法。

@Keithwwa
Copy link
Collaborator Author

Keithwwa commented Mar 3, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

本次 PR 调整了文档结构,将数据集准备指南移至“快速入门”部分,使其更加突出。相关的中英文文档链接和目录都已相应更新。代码审查发现一处可以改进的地方:在一个英文文档的 Markdown 链接中存在一个多余的字符,已在评论中提出修改建议。


**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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

链接 ../get_started/datasets.md# 末尾的 # 是多余的,建议移除以保持链接简洁。虽然它能正常工作,但移除后链接更清晰。

Suggested change
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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[review]链接 ../get_started/datasets.md# 末尾的 # 是多余的,建议移除以保持链接简洁。虽然它能正常工作,但移除后链接更清晰。

@Keithwwa Keithwwa force-pushed the pr_mv_dataset_to_getstart branch from a8577ff to 20ffdc3 Compare March 3, 2026 07:38
@Keithwwa
Copy link
Collaborator Author

Keithwwa commented Mar 3, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

本次 PR 对文档结构进行了调整,将数据集准备指南 (datasets.md) 从 base_tutorials/all_params 目录移动到了 get_started 目录,使其在“快速入门”部分更加突出。为此,PR 中包含了对多个文档文件的修改:重命名了 datasets.md 文件,更新了 index.rst 以反映新的目录结构,并修正了所有指向旧路径的链接。此外,移动后的 datasets.md 文件内部的相对链接也已相应更新。经过审查,所有文件路径和链接的修改均正确无误,未发现任何问题。这次重构有助于改善文档的可读性和导航性。

@GaoHuaZhang GaoHuaZhang merged commit cabe9b4 into AISBench:master Mar 3, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants