Skip to content

modify skill#1055

Open
wzh1994 wants to merge 1 commit intoLazyAGI:mainfrom
wzh1994:wzh/skill
Open

modify skill#1055
wzh1994 wants to merge 1 commit intoLazyAGI:mainfrom
wzh1994:wzh/skill

Conversation

@wzh1994
Copy link
Contributor

@wzh1994 wzh1994 commented Mar 12, 2026

更新lazyllm的skill文档

@wzh1994 wzh1994 requested a review from a team as a code owner March 12, 2026 01:59
@gemini-code-assist
Copy link

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!

此拉取请求主要致力于更新和扩展 lazyllm-skill 的文档。它引入了关于安装、模型使用、API Key 配置、CLI 工具、流式输出以及 lazyllm.tools 概览的新章节。同时,对 Flow、Finetune、RAG、Agent 和最佳实践等现有内容进行了大幅修订,以提供更清晰、更详细的指导,并新增了多个辅助文档来支持特定主题。

Highlights

  • 文档结构与内容更新: 对 docs/lazyllm-skill/SKILL.md 文档进行了大规模重构和内容扩充,新增了安装、模型调用、API Key 配置、CLI 使用、流式输出和本地文档索引等多个重要章节。
  • 核心概念与实践细化: Flow、Finetune、RAG、Agent 和最佳实践等现有章节得到了显著修订和扩展,提供了更清晰、更详细的指导和代码示例。
  • 新增辅助文档: 在 docs/lazyllm-skill/assets/ 目录下新增了多个 Markdown 文件,用于详细说明 API Key 平台、CLI 命令、环境依赖、Launcher 使用、本地模型流式输出、微调相关资源以及 RAG 存储的外部引用。
  • 工具文档增强: 大幅扩展了 docs/lazyllm-skill/assets/agent/tools.md,详细分类并介绍了 lazyllm.tools 中提供的各类搜索、通用、SQL/数据和代码/能力工具。
  • RAG 外部引用集中管理: docs/lazyllm-skill/assets/rag/store.md 中的外部文档链接已更新,统一指向新增的 store_external_refs.md 文件,以便集中管理外部参考资料。
Changelog
  • docs/lazyllm-skill/SKILL.md
    • 对主 LazyLLM 技能文档进行了重大重写和扩展,新增了安装、模型使用、API 密钥、CLI、流式处理和本地文档索引等新章节,并修订了现有内容。
    • 更新了 RAG 和 Agent 的代码示例,以反映新的结构和清晰度。
  • docs/lazyllm-skill/assets/agent/tools.md
    • 扩展了 lazyllm.tools 的文档,详细分类并介绍了各种搜索、通用、SQL/数据和代码/能力工具。
  • docs/lazyllm-skill/assets/basic/api_key_platforms.md
    • 新增了一个文档,详细说明了在线模型 API 密钥的配置和支持平台。
  • docs/lazyllm-skill/assets/basic/cli.md
    • 新增了一个文档,提供了 LazyLLM 命令行界面使用的详细信息。
  • docs/lazyllm-skill/assets/basic/environment.md
    • 新增了一个文档,概述了 LazyLLM 的安装和环境依赖。
  • docs/lazyllm-skill/assets/basic/launcher.md
    • 新增了一个文档,解释了 Launcher 在分布式任务中的使用。
  • docs/lazyllm-skill/assets/basic/local_model_stream.md
    • 新增了一个文档,指导如何进行本地模型的流式输出。
  • docs/lazyllm-skill/assets/finetune/related_resources.md
    • 新增了一个文档,总结了微调相关的资源。
  • docs/lazyllm-skill/assets/rag/store.md
    • 更新了 RAG 存储文档中的外部文档链接,使其指向新的本地参考文件。
  • docs/lazyllm-skill/assets/rag/store_external_refs.md
    • 新增了一个文档,用于集中管理 RAG 存储配置的外部参考资料。
  • docs/lazyllm-skill/references/agent.md
    • 修订了 Agent 文档,更新了核心概念、最佳实践和使用场景。
  • docs/lazyllm-skill/references/finetune.md
    • 更新了“相关资源”部分,使其指向新的本地微调资源文档。
Activity
  • wzh1994 创建了此拉取请求,标题为“modify skill”,描述为“更新lazyllm的skill文档”。
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

@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 对 lazyllm 的 skill 文档进行了全面的重构和更新,显著提升了文档的结构性、清晰度和完整性。新的文档增加了安装、环境配置、模型调用、CLI 使用等入门章节,并对 Flow、Finetune、RAG、Agent 等核心组件的说明进行了优化和精简,使其更适合作为快速参考。将外部链接替换为本地引用,增强了文档的离线可用性。整体来看,这是一次非常有价值的改进。我只发现了一个小的拼写错误,已在评论中指出。

以下为微调相关文档与依赖项目的本地说明,完整教程与外部文档需在项目主 docs 或联网环境下查阅。

- **微调教程**:见项目内 `docs/zh/Tutorial/` 或 `docs/en/Tutorial/`(如 Tutorial 9 等)。
- **LLaMA-Factory**:LazyLLM 使用 LLaMA-Factory 作为大模型微调后端之一;详细用法见项目依赖与 [finetune_framework.md](finetune_framework.md)、[fintune_example.md](fintune_example.md)。

Choose a reason for hiding this comment

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

medium

你好,在文件名 fintune_example.md 中存在一个拼写错误,应该是 finetune_example.md。这个错误会导致链接失效,建议修正。

Suggested change
- **LLaMA-Factory**:LazyLLM 使用 LLaMA-Factory 作为大模型微调后端之一;详细用法见项目依赖与 [finetune_framework.md](finetune_framework.md)[fintune_example.md](fintune_example.md)
- **LLaMA-Factory**:LazyLLM 使用 LLaMA-Factory 作为大模型微调后端之一;详细用法见项目依赖与 [finetune_framework.md](finetune_framework.md)[finetune_example.md](finetune_example.md)

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.

1 participant