diff --git a/docs/source/clis.mdx b/docs/source/clis.mdx index 85d9aef55b1..68c4fcfbf6d 100644 --- a/docs/source/clis.mdx +++ b/docs/source/clis.mdx @@ -35,10 +35,10 @@ lr_scheduler_type: cosine ``` -Save that config in a `.yaml` and get directly started ! Note you can overwrite the arguments from the config file by explicitly passing them to the CLI, e.g.: +Save that config in a `.yaml` and get started immediately! An example CLI config is available as `examples/cli_configs/example_config.yaml`. Note you can overwrite the arguments from the config file by explicitly passing them to the CLI, e.g. from the root folder: ```bash -trl sft --config example_config.yaml --output_dir test-trl-cli --lr_scheduler_type cosine_with_restarts +trl sft --config examples/cli_configs/example_config.yaml --output_dir test-trl-cli --lr_scheduler_type cosine_with_restarts ``` Will force-use `cosine_with_restarts` for `lr_scheduler_type`. diff --git a/example_config.yaml b/examples/cli_configs/example_config.yaml similarity index 100% rename from example_config.yaml rename to examples/cli_configs/example_config.yaml diff --git a/examples/scripts/dpo_visual.py b/examples/scripts/dpo_visual.py index b602c8f0098..cb23adaf602 100644 --- a/examples/scripts/dpo_visual.py +++ b/examples/scripts/dpo_visual.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. """ -accelerate launch examples/scripts/vdpo.py \ +accelerate launch examples/scripts/dpo_visual.py \ --dataset_name HuggingFaceH4/rlaif-v_formatted \ --model_name_or_path HuggingFaceM4/idefics2-8b \ --per_device_train_batch_size 1 \