Skip to content

Commit 2db3e7d

Browse files
committed
fix: correct formatting in nsys-profiling.md installation instructions
Signed-off-by: ruit <ruit@nvidia.com>
1 parent 129cdf5 commit 2db3e7d

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

docs/nsys-profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ NeMo RL supports Nsight profiling for Ray workers through environment variable p
66

77
## Prerequisites
88

9-
* Install NVIDIA Nsight Systems (`nsys`) on the compute nodes where workers will run. For Ubuntu installation instructions, see the [NVIDIA Nsight Systems Installation Guide](https://docs.nvidia.com/nsight-systems/InstallationGuide/index.html#package-manager-installation)).
9+
* Install NVIDIA Nsight Systems (`nsys`) on the compute nodes where workers will run. For Ubuntu installation instructions, see the [NVIDIA Nsight Systems Installation Guide](https://docs.nvidia.com/nsight-systems/InstallationGuide/index.html#package-manager-installation).
1010

1111
**Note: If you're using NeMo RL containers, `nsys` is already installed.**
1212

examples/converters/convert_lora_to_hf.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,22 @@ def export_lora_adapter_to_hf(
258258
hf_model_name: str,
259259
hf_ckpt_path: str,
260260
) -> str:
261-
"""Export only the LoRA adapter in HuggingFace PEFT format without using AutoBridge.export_adapter_ckpt."""
261+
"""Export a Megatron LoRA adapter to HuggingFace PEFT format.
262+
263+
Args:
264+
base_ckpt: Path to the base model Megatron checkpoint (iter_XXXXXXX directory).
265+
adapter_ckpt: Path to the LoRA adapter Megatron checkpoint (iter_XXXXXXX directory).
266+
Must contain a ``run_config.yaml`` with a ``peft`` section.
267+
hf_model_name: HuggingFace model identifier (e.g. ``zai-org/GLM-5``).
268+
hf_ckpt_path: Output directory for the HuggingFace PEFT adapter checkpoint.
269+
270+
Returns:
271+
The *hf_ckpt_path* that was written to.
272+
273+
Raises:
274+
FileExistsError: If *hf_ckpt_path* already exists.
275+
ValueError: If the adapter's ``run_config.yaml`` has no ``peft`` section.
276+
"""
262277
if os.path.exists(hf_ckpt_path):
263278
raise FileExistsError(f"Output path already exists: {hf_ckpt_path}")
264279

0 commit comments

Comments
 (0)