diff --git "a/docs/source/Instruction/\345\221\275\344\273\244\350\241\214\345\217\202\346\225\260.md" "b/docs/source/Instruction/\345\221\275\344\273\244\350\241\214\345\217\202\346\225\260.md" index 60474a3b78..5c6cfd6b01 100644 --- "a/docs/source/Instruction/\345\221\275\344\273\244\350\241\214\345\217\202\346\225\260.md" +++ "b/docs/source/Instruction/\345\221\275\344\273\244\350\241\214\345\217\202\346\225\260.md" @@ -10,16 +10,16 @@ ## 基本参数 - 🔥tuner_backend: 可选为'peft','unsloth'。默认为'peft'。 -- 🔥train_type: 可选为: 'lora'、'full'、'longlora'、'adalora'、'llamapro'、'adapter'、'vera'、'boft'、'fourierft'、'reft'。默认为'lora'。 +- 🔥train_type: 可选为'lora'、'full'、'longlora'、'adalora'、'llamapro'、'adapter'、'vera'、'boft'、'fourierft'、'reft'。默认为'lora'。 - 🔥adapters: 用于指定adapter的id/path的list,默认为`[]`。 - external_plugins: 外部plugin py文件列表,这些文件会被注册进plugin模块中,例子请参见[这里](https://github.com/modelscope/ms-swift/tree/main/examples/train/grpo/plugin/run_external_reward_func.sh)。默认为`[]`。 -- seed: 默认为42。 +- seed: 全局随机种子,默认为42。注意该随机种子与控制数据集随机的`data_seed`相不影响。 - model_kwargs: 特定模型可传入的额外参数,该参数列表会在训练推理时打印日志进行提示。例如`--model_kwargs '{"fps_max_frames": 12}'`。默认为None。 - load_args: 当指定`--resume_from_checkpoint`、`--model`、`--adapters`会读取保存文件中的`args.json`,读取的keys查看[base_args.py](https://github.com/modelscope/ms-swift/blob/main/swift/llm/argument/base_args/base_args.py)。推理和导出时默认为True,训练时默认为False。 -- load_data_args: 如果将该参数设置为True,则会额外读取`args.json`中的数据参数。默认为False。 +- load_data_args: 如果将该参数设置为True,则会额外读取`args.json`中的数据参数。默认为False。通常用于`swift infer`时对训练中切分的验证集进行推理。 - use_hf: 控制模型下载、数据集下载、模型推送使用ModelScope还是HuggingFace。默认为False,使用ModelScope。 - hub_token: hub token. modelscope的hub token可以查看[这里](https://modelscope.cn/my/myaccesstoken)。默认为None。 -- custom_register_path: 自定义模型、对话模板和数据集注册的`.py`文件路径的list。默认为`[]`。 +- custom_register_path: 传入自定义模型、对话模板和数据集注册的`.py`文件路径的列表,这些文件会被额外加载。默认为`[]`。 - ddp_timeout: 默认为18000000,单位为秒。 - ddp_backend: 可选为"nccl"、"gloo"、"mpi"、"ccl"、"hccl" 、"cncl"、"mccl"。默认为None,进行自动选择。 - ignore_args_error: 用于兼容notebook。默认为False。