@baimingtao/lbs-agent 1.0.0

package/extensions/skills/optional/mlops/training/axolotl/references/api.md

@@ -0,0 +1,1535 @@
+# Axolotl - Api
+
+**页数：** 150
+
+---
+
+## cli.cloud.modal_
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.cloud.modal_.html
+
+**内容：**
+- cli.cloud.modal_
+- 类
+  - ModalCloud
+- 函数
+  - run_cmd
+
+通过 CLI 支持 Modal Cloud。
+
+Modal Cloud 实现。
+
+在文件夹内运行命令，在执行前重新加载 Modal Volume，并在成功时进行提交。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.cloud.modal_.ModalCloud(config, app=None)
+```
+
+示例 2 (python):
+```python
+cli.cloud.modal_.run_cmd(cmd, run_folder, volumes=None)
+```
+
+---
+
+## core.trainers.base
+
+**URL:** https://docs.axolotl.ai/docs/api/core.trainers.base.html
+
+**内容：**
+- core.trainers.base
+- 类
+  - AxolotlTrainer
+    - 方法
+      - log
+        - 参数
+      - push_to_hub
+      - store_metrics
+        - 参数
+
+自定义训练器模块
+
+为 axolotl 辅助工具扩展基础 Trainer
+
+在监控训练的各种对象上记录日志，包括存储的 metrics。
+
+重写 push_to_hub 方法，以便在将模型推送到 Hub 时强制添加标签。详情请参阅 ~transformers.Trainer.push_to_hub。
+
+使用指定的 reduction 类型存储 metrics。
+
+**示例:**
+
+示例 1 (python):
+```python
+core.trainers.base.AxolotlTrainer(
+    *_args,
+    bench_data_collator=None,
+    eval_data_collator=None,
+    dataset_tags=None,
+    **kwargs,
+)
+```
+
+示例 2 (python):
+```python
+core.trainers.base.AxolotlTrainer.log(logs, start_time=None)
+```
+
+示例 3 (python):
+```python
+core.trainers.base.AxolotlTrainer.push_to_hub(*args, **kwargs)
+```
+
+示例 4 (python):
+```python
+core.trainers.base.AxolotlTrainer.store_metrics(
+    metrics,
+    train_eval='train',
+    reduction='mean',
+)
+```
+
+---
+
+## prompt_strategies.input_output
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_strategies.input_output.html
+
+**内容：**
+- prompt_strategies.input_output
+- 类
+  - RawInputOutputPrompter
+  - RawInputOutputStrategy
+
+prompt_strategies.input_output
+
+用于纯输入/输出 prompt 对的模块
+
+用于原始 I/O 数据的 prompter
+
+用于输入/输出对的 Prompt Strategy 类
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_strategies.input_output.RawInputOutputPrompter()
+```
+
+示例 2 (python):
+```python
+prompt_strategies.input_output.RawInputOutputStrategy(
+    *args,
+    eos_token=None,
+    **kwargs,
+)
+```
+
+---
+
+## prompt_strategies.completion
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_strategies.completion.html
+
+**内容：**
+- prompt_strategies.completion
+- 类
+  - CompletionPromptTokenizingStrategy
+  - CompletionPrompter
+
+prompt_strategies.completion
+
+基础补全文本
+
+用于 Completion prompts 的分词策略。
+
+用于补全的 Prompter
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_strategies.completion.CompletionPromptTokenizingStrategy(
+    *args,
+    max_length=None,
+    **kwargs,
+)
+```
+
+示例 2 (python):
+```python
+prompt_strategies.completion.CompletionPrompter()
+```
+
+---
+
+## utils.collators.core
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.collators.core.html
+
+**内容：**
+- utils.collators.core
+
+基础共享 collator 常量
+
+---
+
+## monkeypatch.data.batch_dataset_fetcher
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.data.batch_dataset_fetcher.html
+
+**内容：**
+- monkeypatch.data.batch_dataset_fetcher
+- 函数
+  - apply_multipack_dataloader_patch
+  - patch_fetchers
+  - patched_worker_loop
+  - remove_multipack_dataloader_patch
+
+monkeypatch.data.batch_dataset_fetcher
+
+用于处理打包索引批次的 dataset fetcher 的 Monkey patch。
+
+此 patch 允许 DataLoader 正确处理包含打包序列的多个 bin 的批次。
+
+将 patch 应用到 PyTorch 的 DataLoader 组件。
+
+确保在 worker 进程中应用 patch 的 Worker 循环。
+
+移除 monkeypatch 并恢复原有的 PyTorch DataLoader 行为。
+
+**示例:**
+
+示例 1 (python):
+```python
+monkeypatch.data.batch_dataset_fetcher.apply_multipack_dataloader_patch()
+```
+
+示例 2 (python):
+```python
+monkeypatch.data.batch_dataset_fetcher.patch_fetchers()
+```
+
+示例 3 (python):
+```python
+monkeypatch.data.batch_dataset_fetcher.patched_worker_loop(*args, **kwargs)
+```
+
+示例 4 (python):
+```python
+monkeypatch.data.batch_dataset_fetcher.remove_multipack_dataloader_patch()
+```
+
+---
+
+## core.datasets.chat
+
+**URL:** https://docs.axolotl.ai/docs/api/core.datasets.chat.html
+
+**内容：**
+- core.datasets.chat
+- 类
+  - TokenizedChatDataset
+
+分词后的对话数据集
+
+**示例:**
+
+示例 1 (python):
+```python
+core.datasets.chat.TokenizedChatDataset(
+    data,
+    model_transform,
+    *args,
+    message_transform=None,
+    formatter=None,
+    process_count=None,
+    keep_in_memory=False,
+    **kwargs,
+)
+```
+
+---
+
+## utils.freeze
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.freeze.html
+
+**内容：**
+- utils.freeze
+- 类
+  - LayerNamePattern
+    - 方法
+      - match
+- 函数
+  - freeze_layers_except
+
+通过名称冻结/解冻参数的模块
+
+表示层名称的正则表达式模式，可能包含参数索引范围。
+
+检查给定的层名是否匹配该正则表达式模式。
+
+参数： - name (str): 要检查的层名。
+
+返回： - bool: 如果层名匹配模式则为 True，否则为 False。
+
+冻结给定模型的所有层，除了匹配给定正则表达式模式的层。模式中的句点被视为字面句点，而不是通配符。
+
+参数： - model (nn.Module): 要修改的 PyTorch 模型。 - regex_patterns (list of str): 用于匹配层名以保持解冻的正则表达式模式列表。请注意，您不能在模式中使用点作为通配符，因为它是保留用于分隔层名的。此外，要匹配整个层名，模式应以 “^” 开头并以 “\(” 结尾，否则它将匹配层名的任何部分。范围模式部分是可选的，并且不会被编译为正则表达式，这意味着如果您想匹配整个层名，必须在范围模式之前加上 "\)” 。例如：["^model.embed_tokens.weight\([:32000]", "layers.2[0-9]+.block_sparse_moe.gate.[a-z]+\)”]
+
+返回： None；模型将被原地进行修改。
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.freeze.LayerNamePattern(pattern)
+```
+
+示例 2 (python):
+```python
+utils.freeze.LayerNamePattern.match(name)
+```
+
+示例 3 (python):
+```python
+utils.freeze.freeze_layers_except(model, regex_patterns)
+```
+
+---
+
+## monkeypatch.unsloth_
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.unsloth_.html
+
+**内容：**
+- monkeypatch.unsloth_
+
+用于应用 unsloth 优化的 patch 模块
+
+---
+
+## utils.schemas.datasets
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.schemas.datasets.html
+
+**内容：**
+- utils.schemas.datasets
+- 类
+  - DPODataset
+  - KTODataset
+  - PretrainingDataset
+  - SFTDataset
+    - 方法
+      - handle_legacy_message_fields
+  - StepwiseSupervisedDataset
+  - UserDefinedDPOType
+
+utils.schemas.datasets
+
+用于数据集相关配置的 Pydantic 模型
+
+DPO 配置子集
+
+KTO 配置子集
+
+预训练数据集配置子集
+
+SFT 配置子集
+
+处理旧版消息字段映射与新属性映射系统之间的向后兼容性。
+
+步进式监督数据集配置子集
+
+用于 DPO 的用户自定义类型
+
+用于 KTO 的用户自定义类型
+
+用于用户自定义 prompt 类型的结构
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.schemas.datasets.DPODataset()
+```
+
+示例 2 (python):
+```python
+utils.schemas.datasets.KTODataset()
+```
+
+示例 3 (python):
+```python
+utils.schemas.datasets.PretrainingDataset()
+```
+
+示例 4 (python):
+```python
+utils.schemas.datasets.SFTDataset()
+```
+
+---
+
+## core.chat.format.llama3x
+
+**URL:** https://docs.axolotl.ai/docs/api/core.chat.format.llama3x.html
+
+**内容：**
+- core.chat.format.llama3x
+
+core.chat.format.llama3x
+
+用于 MessageContents 的 Llama 3.x 对话格式化函数
+
+---
+
+## datasets
+
+**URL:** https://docs.axolotl.ai/docs/api/datasets.html
+
+**内容：**
+- datasets
+- 类
+  - TokenizedPromptDataset
+    - 参数
+
+包含数据集功能的模块。
+
+我们希望它是已加载的现有数据集的包装器。让我们使用中间件的概念来包装每个数据集。稍后我们将使用 collators 来填充数据集。
+
+从文本流中返回分词后 prompts 的数据集。
+
+**示例:**
+
+示例 1 (python):
+```python
+datasets.TokenizedPromptDataset(
+    prompt_tokenizer,
+    dataset,
+    process_count=None,
+    keep_in_memory=False,
+    **kwargs,
+)
+```
+
+---
+
+## prompt_strategies.bradley_terry.llama3
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_strategies.bradley_terry.llama3.html
+
+**内容：**
+- prompt_strategies.bradley_terry.llama3
+- 函数
+  - icr
+
+prompt_strategies.bradley_terry.llama3
+
+针对包含 system、input、chosen、rejected 的数据集的 chatml 转换，以匹配 llama3 对话模板
+
+针对包含 system、input、chosen、rejected 的数据集的 chatml 转换，例如 https://huggingface.co/datasets/argilla/distilabel-intel-orca-dpo-pairs
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_strategies.bradley_terry.llama3.icr(cfg, **kwargs)
+```
+
+---
+
+## common.datasets
+
+**URL:** https://docs.axolotl.ai/docs/api/common.datasets.html
+
+**内容：**
+- common.datasets
+- 类
+  - TrainDatasetMeta
+- 函数
+  - load_datasets
+    - 参数
+    - 返回
+  - load_preference_datasets
+    - 参数
+    - 返回
+
+数据集加载工具。
+
+包含训练和验证数据集及元数据字段的 Dataclass。
+
+加载一个或多个训练或评估数据集，调用 axolotl.utils.data.prepare_datasets。可选地输出调试信息。
+
+通过配对的偏好数据，为 RL 训练加载一个或多个训练或评估数据集，调用 axolotl.utils.data.rl.prepare_preference_datasets。可选地输出调试信息。
+
+从数据集中带放回地随机抽取 num_samples 个样本。
+
+**示例:**
+
+示例 1 (python):
+```python
+common.datasets.TrainDatasetMeta(
+    train_dataset,
+    eval_dataset=None,
+    total_num_steps=None,
+)
+```
+
+示例 2 (python):
+```python
+common.datasets.load_datasets(cfg, cli_args=None, debug=False)
+```
+
+示例 3 (python):
+```python
+common.datasets.load_preference_datasets(cfg, cli_args=None)
+```
+
+示例 4 (python):
+```python
+common.datasets.sample_dataset(dataset, num_samples)
+```
+
+---
+
+## cli.train
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.train.html
+
+**内容：**
+- cli.train
+- 函数
+  - do_cli
+    - 参数
+  - do_train
+    - 参数
+
+在模型上运行训练的 CLI。
+
+解析 axolotl 配置、CLI 参数并调用 do_train。
+
+通过先加载 axolotl 配置中指定的一个或多个数据集，然后调用 axolotl.train.train 来训练 transformers 模型。训练完成后还会运行插件管理器的 post_train_unload。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.train.do_cli(config=Path('examples/'), **kwargs)
+```
+
+示例 2 (python):
+```python
+cli.train.do_train(cfg, cli_args)
+```
+
+---
+
+## cli.utils.fetch
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.utils.fetch.html
+
+**内容：**
+- cli.utils.fetch
+- 函数
+  - fetch_from_github
+    - 参数
+
+axolotl fetch CLI 命令的工具。
+
+从 GitHub 仓库的特定目录同步文件。仅下载本地不存在或已更改的文件。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.utils.fetch.fetch_from_github(dir_prefix, dest_dir=None, max_workers=5)
+```
+
+---
+
+## utils.tokenization
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.tokenization.html
+
+**内容：**
+- utils.tokenization
+- 函数
+  - color_token_for_rl_debug
+  - process_tokens_for_rl_debug
+
+分词工具模块
+
+根据 token 类型为其着色的辅助函数。
+
+用于处理和为 token 着色的辅助函数。
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.tokenization.color_token_for_rl_debug(
+    decoded_token,
+    encoded_token,
+    color,
+    text_only,
+)
+```
+
+示例 2 (python):
+```python
+utils.tokenization.process_tokens_for_rl_debug(
+    tokens,
+    color,
+    tokenizer,
+    text_only,
+)
+```
+
+---
+
+## core.trainers.grpo.sampler
+
+**URL:** https://docs.axolotl.ai/docs/api/core.trainers.grpo.sampler.html
+
+**内容：**
+- core.trainers.grpo.sampler
+- 类
+  - SequenceParallelRepeatRandomSampler
+    - 参数
+    - 方法
+      - set_epoch
+        - 参数
+
+core.trainers.grpo.sampler
+
+重复随机采样器（类似于在 https://github.com/huggingface/trl/blob/main/trl/trainer/grpo_trainer.py 中实现的那样），增加了序列并行功能；即在同一个序列并行组中的不同 rank 之间复制数据。
+
+带有序列并行的 GRPO 训练 Sampler。
+
+此 sampler 确保： - 同一个序列并行 (SP) 组中的 rank 接收到相同的数据。 - 每个索引被重复多次以采样不同的补全。 - 整个批次被重复以在多次更新中重用。 - 数据跨 SP 组正确分配。
+
+在下表中，值代表数据集索引。每个 SP 组有 context_parallel_size = 2 个 GPU 协作处理相同的数据。共有 2 个 SP 组（SP0 和 SP1），world_size = 4 个总 GPU。
+
+grad_accum=2 ▲ ▲ 0 0 [0 0 0 1 1 1] [2 2 2 3 3 3] <- SP 组获取不同的数据 ▼ | 0 1 [0 0 0 1 1 1] [2 2 2 3 3 3] <- 每个 SP 组获取相同的数据 GPU |  | 1 2 [0 0 0 1 1 1] [2 2 2 3 3 3] <- 重复相同索引以进行迭代 num_iterations=2 ▼ 1 3 [0 0 0 1 1 1] [2 2 2 3 3 3] <- 当使用梯度累积时
+
+为此 sampler 设置 epoch。
+
+**示例:**
+
+示例 1 (python):
+```python
+core.trainers.grpo.sampler.SequenceParallelRepeatRandomSampler(
+    dataset,
+    mini_repeat_count,
+    world_size,
+    rank,
+    batch_size=1,
+    repeat_count=1,
+    context_parallel_size=1,
+    shuffle=True,
+    seed=0,
+    drop_last=False,
+)
+```
+
+示例 2 (unknown):
+```unknown
+Sequence Parallel Groups
+                                |       SP0        |       SP1        |
+                                |  GPU 0  |  GPU 1 |  GPU 2  |  GPU 3 |
+            global_step  step    <---> mini_repeat_count=3
+                                    <----------> batch_size=2 per SP group
+```
+
+示例 3 (unknown):
+```unknown
+2       4         [4 4 4  5 5 5]     [6 6 6  7 7 7]   <- New batch of data indices
+                 2       5         [4 4 4  5 5 5]     [6 6 6  7 7 7]
+                                    ...
+```
+
+示例 4 (python):
+```python
+core.trainers.grpo.sampler.SequenceParallelRepeatRandomSampler.set_epoch(epoch)
+```
+
+---
+
+## evaluate
+
+**URL:** https://docs.axolotl.ai/docs/api/evaluate.html
+
+**内容：**
+- evaluate
+- 函数
+  - evaluate
+    - 参数
+    - 返回
+  - evaluate_dataset
+    - 参数
+    - 返回
+
+用于模型评估的模块。
+
+在训练和验证数据集上评估模型。
+
+用于评估单个数据集的辅助函数。
+
+**示例:**
+
+示例 1 (python):
+```python
+evaluate.evaluate(cfg, dataset_meta)
+```
+
+示例 2 (python):
+```python
+evaluate.evaluate_dataset(trainer, dataset, dataset_type, flash_optimum=False)
+```
+
+---
+
+## utils.optimizers.adopt
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.optimizers.adopt.html
+
+**内容：**
+- utils.optimizers.adopt
+- 函数
+  - adopt
+
+utils.optimizers.adopt
+
+复制自 https://github.com/iShohei220/adopt
+
+ADOPT: Modified Adam Can Converge with Any β2 with the Optimal Rate (2024) Taniguchi, Shohei and Harada, Keno and Minegishi, Gouki and Oshima, Yuta and Jeong, Seong Cheol and Nagahara, Go and Iiyama, Tomoshi and Suzuki, Masahiro and Iwasawa, Yusuke and Matsuo, Yutaka
+
+执行 ADOPT 算法计算的函数式 API。
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.optimizers.adopt.adopt(
+    params,
+    grads,
+    exp_avgs,
+    exp_avg_sqs,
+    state_steps,
+    foreach=None,
+    capturable=False,
+    differentiable=False,
+    fused=None,
+    grad_scale=None,
+    found_inf=None,
+    has_complex=False,
+    *,
+    beta1,
+    beta2,
+    lr,
+    clip_lambda,
+    weight_decay,
+    decouple,
+    eps,
+    maximize,
+)
+```
+
+---
+
+## prompt_tokenizers
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_tokenizers.html
+
+**内容：**
+- prompt_tokenizers
+- 类
+  - AlpacaMultipleChoicePromptTokenizingStrategy
+  - AlpacaPromptTokenizingStrategy
+  - AlpacaReflectionPTStrategy
+  - DatasetWrappingStrategy
+  - GPTeacherPromptTokenizingStrategy
+  - InstructionPromptTokenizingStrategy
+  - InvalidDataException
+  - JeopardyPromptTokenizingStrategy
+
+包含 PromptTokenizingStrategy 和 Prompter 类的模块
+
+用于 Alpaca 多项选择 prompts 的分词策略。
+
+用于 Alpaca prompts 的分词策略。
+
+用于 Alpaca Reflection prompts 的分词策略。
+
+用于包装对话消息数据集的抽象类
+
+用于 GPTeacher prompts 的分词策略。
+
+用于基于指令的 prompts 的分词策略。
+
+当数据无效时引发的异常
+
+用于 Jeopardy prompts 的分词策略。
+
+用于 NomicGPT4All prompts 的分词策略。
+
+用于 OpenAssistant prompts 的分词策略。
+
+分词策略的抽象类
+
+用于 Reflection prompts 的分词策略。
+
+用于 SummarizeTLDR prompts 的分词策略。
+
+解析已分词的 prompt，并将分词后的 input_ids、attention_mask 和 labels 追加到结果中
+
+返回分词 prompt 函数的默认值
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_tokenizers.AlpacaMultipleChoicePromptTokenizingStrategy(
+    prompter,
+    tokenizer,
+    train_on_inputs=False,
+    sequence_len=2048,
+)
+```
+
+示例 2 (python):
+```python
+prompt_tokenizers.AlpacaPromptTokenizingStrategy(
+    prompter,
+    tokenizer,
+    train_on_inputs=False,
+    sequence_len=2048,
+)
+```
+
+示例 3 (python):
+```python
+prompt_tokenizers.AlpacaReflectionPTStrategy(
+    prompter,
+    tokenizer,
+    train_on_inputs=False,
+    sequence_len=2048,
+)
+```
+
+示例 4 (python):
+```python
+prompt_tokenizers.DatasetWrappingStrategy()
+```
+
+---
+
+## cli.art
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.art.html
+
+**内容：**
+- cli.art
+- 函数
+  - print_axolotl_text_art
+
+Axolotl ASCII 徽标工具。
+
+打印 axolotl ASCII 艺术。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.art.print_axolotl_text_art()
+```
+
+---
+
+## utils.callbacks.perplexity
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.callbacks.perplexity.html
+
+**内容：**
+- utils.callbacks.perplexity
+- 类
+  - Perplexity
+    - 方法
+      - compute
+
+utils.callbacks.perplexity
+
+用于计算作为评估指标的困惑度的 callback。
+
+计算定义于 https://huggingface.co/docs/transformers/en/perplexity 的困惑度。这是一个自定义的变体，它不会重新对输入进行分词或重新加载模型。
+
+在序列的固定长度滑动窗口中计算困惑度。
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.callbacks.perplexity.Perplexity(tokenizer, max_seq_len, stride=512)
+```
+
+示例 2 (python):
+```python
+utils.callbacks.perplexity.Perplexity.compute(model, references=None)
+```
+
+---
+
+## cli.utils.train
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.utils.train.html
+
+**内容：**
+- cli.utils.train
+- 函数
+  - build_command
+    - 参数
+    - 返回
+  - generate_config_files
+    - 参数
+  - launch_training
+
+axolotl train CLI 命令的工具。
+
+根据基础命令和选项构建命令列表。
+
+生成要处理的配置文件列表。生成一个元组，包含配置文件名和一个布尔值，指示这是否是一组配置（即 sweep）。
+
+使用给定配置执行训练。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.utils.train.build_command(base_cmd, options)
+```
+
+示例 2 (python):
+```python
+cli.utils.train.generate_config_files(config, sweep)
+```
+
+示例 3 (python):
+```python
+cli.utils.train.launch_training(
+    cfg_file,
+    launcher,
+    cloud,
+    kwargs,
+    launcher_args=None,
+    use_exec=False,
+)
+```
+
+---
+
+## cli.vllm_serve
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.vllm_serve.html
+
+**内容：**
+- cli.vllm_serve
+- 类
+  - AxolotlScriptArguments
+- 函数
+  - do_vllm_serve
+    - 返回
+
+为在线 RL 启动 vllm 服务器的 CLI
+
+VLLM 服务器的附加参数
+
+启动 VLLM 服务器，用于提供在线 RL 使用的 LLM 模型
+
+参数 :param cfg: 解析后的 YAML 配置字典 :param cli_args: VllmServeCliArgs 类型的附加命令行参数字典
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.vllm_serve.AxolotlScriptArguments(
+    reasoning_parser='',
+    enable_reasoning=None,
+)
+```
+
+示例 2 (python):
+```python
+cli.vllm_serve.do_vllm_serve(config, cli_args)
+```
+
+---
+
+## convert
+
+**URL:** https://docs.axolotl.ai/docs/api/convert.html
+
+**内容：**
+- convert
+- 类
+  - FileReader
+  - FileWriter
+  - JsonParser
+  - JsonToJsonlConverter
+  - JsonlSerializer
+  - StdoutWriter
+
+包含 File Reader、File Writer、Json Parser 和 Jsonl Serializer 类的模块
+
+读取文件并以字符串形式返回其内容
+
+将字符串写入文件
+
+将字符串解析为 JSON 并返回结果
+
+将 JSON 文件转换为 JSONL
+
+将 JSON 对象列表序列化为 JSONL 字符串
+
+将字符串写入 stdout
+
+**示例:**
+
+示例 1 (python):
+```python
+convert.FileReader()
+```
+
+示例 2 (python):
+```python
+convert.FileWriter(file_path)
+```
+
+示例 3 (python):
+```python
+convert.JsonParser()
+```
+
+示例 4 (python):
+```python
+convert.JsonToJsonlConverter(
+    file_reader,
+    file_writer,
+    json_parser,
+    jsonl_serializer,
+)
+```
+
+---
+
+## monkeypatch.utils
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.utils.html
+
+**内容：**
+- monkeypatch.utils
+- 函数
+  - get_cu_seqlens
+  - get_cu_seqlens_from_pos_ids
+  - mask_2d_to_4d
+
+用于 monkeypatch 的共享工具
+
+使用 attn mask 为 flash attention 生成累积序列长度掩码
+
+使用 pos ids 为 flash attention 生成累积序列长度掩码
+
+将 attention_mask 从 [bsz, seq_len] 扩展到 [bsz, 1, tgt_seq_len, src_seq_len]。此扩展处理了打包序列，使得序列在同一序列内互相注意时共享相同的注意力掩码整数值。此扩展将掩码转换为下三角形式，以防止未来信息的窥视。
+
+**示例:**
+
+示例 1 (python):
+```python
+monkeypatch.utils.get_cu_seqlens(attn_mask)
+```
+
+示例 2 (python):
+```python
+monkeypatch.utils.get_cu_seqlens_from_pos_ids(position_ids)
+```
+
+示例 3 (python):
+```python
+monkeypatch.utils.mask_2d_to_4d(mask, dtype, tgt_len=None)
+```
+
+---
+
+## prompt_strategies.pygmalion
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_strategies.pygmalion.html
+
+**内容：**
+- prompt_strategies.pygmalion
+- 类
+  - PygmalionPromptTokenizingStrategy
+  - PygmalionPrompter
+
+prompt_strategies.pygmalion
+
+包含 PygmalionPromptTokenizingStrategy 和 PygmalionPrompter 类的模块
+
+用于 Pygmalion 的分词策略。
+
+用于 Pygmalion 的 Prompter。
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_strategies.pygmalion.PygmalionPromptTokenizingStrategy(
+    prompter,
+    tokenizer,
+    *args,
+    **kwargs,
+)
+```
+
+示例 2 (python):
+```python
+prompt_strategies.pygmalion.PygmalionPrompter(*args, **kwargs)
+```
+
+---
+
+## utils.callbacks.mlflow_
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.callbacks.mlflow_.html
+
+**内容：**
+- utils.callbacks.mlflow_
+- 类
+  - SaveAxolotlConfigtoMlflowCallback
+
+utils.callbacks.mlflow_
+
+用于训练器 callbacks 的 MLFlow 模块
+
+将 axolotl 配置保存到 mlflow 的 callback
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.callbacks.mlflow_.SaveAxolotlConfigtoMlflowCallback(axolotl_config_path)
+```
+
+---
+
+## loaders.adapter
+
+**URL:** https://docs.axolotl.ai/docs/api/loaders.adapter.html
+
+**内容：**
+- loaders.adapter
+- 函数
+  - setup_quantized_meta_for_peft
+  - setup_quantized_peft_meta_for_training
+
+Adapter 加载功能，包括 LoRA / QLoRA 及相关工具
+
+用一个虚函数替换 quant_state.to，以防止 PEFT 将 quant_state 移至 meta 设备
+
+用原始函数替换虚设的 quant_state.to 方法，以允许训练继续进行
+
+**示例:**
+
+示例 1 (python):
+```python
+loaders.adapter.setup_quantized_meta_for_peft(model)
+```
+
+示例 2 (python):
+```python
+loaders.adapter.setup_quantized_peft_meta_for_training(model)
+```
+
+---
+
+## cli.cloud.base
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.cloud.base.html
+
+**内容：**
+- cli.cloud.base
+- 类
+  - Cloud
+
+用于 CLI 中云平台的基类
+
+云平台的抽象基类。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.cloud.base.Cloud()
+```
+
+---
+
+## monkeypatch.llama_attn_hijack_flash
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.llama_attn_hijack_flash.html
+
+**内容：**
+- monkeypatch.llama_attn_hijack_flash
+- 函数
+  - flashattn_forward_with_s2attn
+
+monkeypatch.llama_attn_hijack_flash
+
+用于 llama 模型的 Flash attention monkey patch
+
+输入形状：Batch x Time x Channel
+
+来自：https://github.com/dvlab-research/LongLoRA/blob/main/llama_attn_replace.py
+
+attention_mask: [bsz, q_len]
+
+如果提供，cu_seqlens 将被忽略 如果提供，max_seqlen 将被忽略
+
+**示例:**
+
+示例 1 (python):
+```python
+monkeypatch.llama_attn_hijack_flash.flashattn_forward_with_s2attn(
+    self,
+    hidden_states,
+    attention_mask=None,
+    position_ids=None,
+    past_key_value=None,
+    output_attentions=False,
+    use_cache=False,
+    padding_mask=None,
+    cu_seqlens=None,
+    max_seqlen=None,
+)
+```
+
+---
+
+## monkeypatch.llama_patch_multipack
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.llama_patch_multipack.html
+
+**内容：**
+- monkeypatch.llama_patch_multipack
+
+monkeypatch.llama_patch_multipack
+
+Patched LlamaAttention 以使用 torch.nn.functional.scaled_dot_product_attention
+
+---
+
+## cli.inference
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.inference.html
+
+**内容：**
+- cli.inference
+- 函数
+  - do_cli
+    - 参数
+  - do_inference
+    - 参数
+  - do_inference_gradio
+    - 参数
+  - get_multi_line_input
+    - 返回
+
+在已训练模型上运行推理的 CLI。
+
+解析 axolotl 配置、CLI 参数并调用 do_inference 或 do_inference_gradio。
+
+在命令行中循环运行推理。接受用户输入，（可选地）应用对话模板，并使用 axolotl 配置中指定的模型根据默认的生成配置生成补全。
+
+在 Gradio 界面中运行推理。接受用户输入，（可选地）应用对话模板，并使用 axolotl 配置中指定的模型根据默认的生成配置生成补全。
+
+从终端获取多行输入。
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.inference.do_cli(config=Path('examples/'), gradio=False, **kwargs)
+```
+
+示例 2 (python):
+```python
+cli.inference.do_inference(cfg, cli_args)
+```
+
+示例 3 (python):
+```python
+cli.inference.do_inference_gradio(cfg, cli_args)
+```
+
+示例 4 (python):
+```python
+cli.inference.get_multi_line_input()
+```
+
+---
+
+## loaders.tokenizer
+
+**URL:** https://docs.axolotl.ai/docs/api/loaders.tokenizer.html
+
+**内容：**
+- loaders.tokenizer
+- 函数
+  - load_tokenizer
+  - modify_tokenizer_files
+    - 参数
+    - 返回
+
+Tokenizer 加载功能及相关工具
+
+根据提供的配置加载和配置 tokenizer。
+
+修改 tokenizer 文件以替换 added_tokens 字符串，保存到输出目录，并返回修改后 tokenizer 的路径。
+
+这仅适用于添加到 tokenizer 中的保留 token，不适用于词汇表中已有的 token。
+
+参考：https://github.com/huggingface/transformers/issues/27974#issuecomment-1854188941
+
+**示例:**
+
+示例 1 (python):
+```python
+loaders.tokenizer.load_tokenizer(cfg)
+```
+
+示例 2 (python):
+```python
+loaders.tokenizer.modify_tokenizer_files(
+    tokenizer_path,
+    token_mappings,
+    output_dir,
+)
+```
+
+---
+
+## cli.utils.sweeps
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.utils.sweeps.html
+
+**内容：**
+- cli.utils.sweeps
+- 函数
+  - generate_sweep_configs
+    - 参数
+    - 返回
+    - 示例
+
+用于处理 axolotl train CLI 命令的配置 sweep 的工具
+
+通过将 sweeps 应用于基础配置，递归生成所有可能的配置。
+
+sweeps_config = { ‘learning_rate’: [0.1, 0.01], ’_’: [ {‘load_in_8bit’: True, ‘adapter’: ‘lora’}, {‘load_in_4bit’: True, ‘adapter’: ‘qlora’} ] }
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.utils.sweeps.generate_sweep_configs(base_config, sweeps_config)
+```
+
+---
+
+## prompt_strategies.dpo.chatml
+
+**URL:** https://docs.axolotl.ai/docs/api/prompt_strategies.dpo.chatml.html
+
+**内容：**
+- prompt_strategies.dpo.chatml
+- 函数
+  - argilla_chat
+  - icr
+  - intel
+  - ultra
+
+prompt_strategies.dpo.chatml
+
+用于 chatml 的 DPO 策略
+
+用于 argilla/dpo-mix-7k 对话
+
+针对包含 system、input、chosen、rejected 的数据集的 chatml 转换，例如 https://huggingface.co/datasets/argilla/distilabel-intel-orca-dpo-pairs
+
+用于 Intel Orca DPO Pairs
+
+用于 ultrafeedback 二值化对话
+
+**示例:**
+
+示例 1 (python):
+```python
+prompt_strategies.dpo.chatml.argilla_chat(cfg, **kwargs)
+```
+
+示例 2 (python):
+```python
+prompt_strategies.dpo.chatml.icr(cfg, **kwargs)
+```
+
+示例 3 (python):
+```python
+prompt_strategies.dpo.chatml.intel(cfg, **kwargs)
+```
+
+示例 4 (python):
+```python
+prompt_strategies.dpo.chatml.ultra(cfg, **kwargs)
+```
+
+---
+
+## cli.quantize
+
+**URL:** https://docs.axolotl.ai/docs/api/cli.quantize.html
+
+**内容：**
+- cli.quantize
+- 函数
+  - do_quantize
+    - 参数
+
+使用 torchao 对模型进行训练后量化的 CLI
+
+量化模型权重
+
+**示例:**
+
+示例 1 (python):
+```python
+cli.quantize.do_quantize(config, cli_args)
+```
+
+---
+
+## utils.dict
+
+**URL:** https://docs.axolotl.ai/docs/api/utils.dict.html
+
+**内容：**
+- utils.dict
+- 类
+  - DictDefault
+- 函数
+  - remove_none_values
+
+包含 DictDefault 类的模块
+
+一个对于缺失键返回 None 而不是返回空 Dict 的 Dict。
+
+从类似字典的对象或列表中移除 null 值。这些值可能是由于数据集加载导致 schema 合并而出现的。参见 https://github.com/axolotl-ai-cloud/axolotl/pull/2909
+
+**示例:**
+
+示例 1 (python):
+```python
+utils.dict.DictDefault()
+```
+
+示例 2 (python):
+```python
+utils.dict.remove_none_values(obj)
+```
+
+---
+
+## API 参考
+
+**URL:** https://docs.axolotl.ai/docs/api/
+
+**内容：**
+- API Reference
+- Core
+- CLI
+- Trainers
+- Model Loading
+- Mixins
+- Context Managers
+- Prompt Strategies
+- Kernels
+- Monkey Patches
+
+用于训练的核心功能
+
+命令行界面
+
+训练实现
+
+用于加载和修补模型、tokenizer 等的功能
+
+用于增强训练器的 Mixin 类
+
+用于更改训练器行为的上下文管理器
+
+Prompt 格式化策略
+
+低级性能优化
+
+用于模型优化的运行时 patch
+
+用于 Axolotl 配置的 Pydantic 数据模型
+
+第三方集成和扩展
+
+通用工具和共享功能
+
+自定义模型实现
+
+数据处理工具
+
+---
+
+## monkeypatch.lora_kernels
+
+**URL:** https://docs.axolotl.ai/docs/api/monkeypatch.lora_kernels.html
+
+**内容：**
+- monkeypatch.lora_kernels
+- 类
+  - FakeMLP
+- 函数
+  - apply_lora_kernel_patches
+    - 参数
+    - 返回
+    - 引发
+    - 注意
+  - get_attention_cls_from_config
+
+monkeypatch.lora_kernels
+
+用于 patch 自定义 LoRA Triton kernel 和 torch.autograd 函数的模块。
+
+用于 triton patching 的占位符 MLP
+
+将优化的 Triton kernel patch 应用到 PEFT 模型。
+
+用 MLP 和注意力计算的优化实现来 patch PEFT 模型。这些优化包括用于激活函数的自定义 Triton kernel 以及用于 LoRA 计算的专用 autograd 函数。
+
+这些优化要求 LoRA adapter 没有 dropout 且没有偏置项。如果不满足这些条件，函数将跳过 patching。
+
+通过检查模型配置获取适当的 attention 类。使用动态导入以支持遵循标准 transformers 命名约定的任何模型架构。
+
+获取模型的各层。处理纯文本和多模态模型。
+
+没有优化的输出投影原始实现。
+
+没有优化的 QKV 投影原始实现。
+
+给定一个 axolotl 配置，此方法使用优化的 LoRA 实现 patch