NeMo RL Documentation#
Welcome to the NeMo RL documentation. NeMo RL is an open-source post-training library developed by NVIDIA, designed to streamline and scale reinforcement learning methods for multimodal models (LLMs, VLMs, etc.).
This documentation provides comprehensive guides, examples, and references to help you get started with NeMo RL and build powerful post-training pipelines for your models.
Getting Started#
Learn about NeMo RL’s architecture, design philosophy, and key features that make it ideal for scalable reinforcement learning.
Get up and running quickly with examples for both Automodel and Megatron Core training backends.
Step-by-step instructions for installing NeMo RL, including prerequisites, system dependencies, and environment setup.
Explore the current features and upcoming enhancements in NeMo RL, including distributed training, advanced parallelism, and more.
Troubleshooting common issues including missing submodules and memory fragmentation.
Training and Generation#
Learn about Automodel and Megatron Core training backends, their capabilities, and how to choose the right one for your use case.
Discover supported algorithms including GRPO, PPO, SFT, DPO, RM, on-policy distillation, and multi-teacher on-policy distillation (MOPD) with detailed guides and examples.
Measure model and agent capabilities with repeatable benchmarks and custom evaluations.
Configure and launch NeMo RL on multi-node Slurm or Kubernetes clusters for distributed computing.
Run a fixed Dynamo vLLM fleet with NCCL refit and W&B telemetry inside a Slurm Ray allocation.
Guides and Examples#
Reproduce DeepscaleR results with NeMo RL using GRPO on mathematical reasoning tasks.
Step-by-step guide for supervised fine-tuning on the OpenMathInstruct2 dataset.
Post-train Nemotron 3 Ultra with RLVR, teacher training, and MOPD stages on GB200 NVL72 hardware.
Create custom reward environments and integrate them with NeMo RL training pipelines.
Configure offline and online Eagle3 draft-model workflows to accelerate rollout generation with vLLM.
Co-train DSpark, DFlash, and EAGLE3 drafters alongside the policy on the Automodel backend.
Train Qwen2.5-Omni-3B with GRPO on AVQA and evaluate on MMAU, following the R1-AQA approach.
Train Qwen2.5-Omni-7B with GRPO on PhilipC/IntentTrain (audio-visual intent recognition) and evaluate on Daily-Omni, following HumanOmniV2’s joint audio-visual setup.
Train Qwen3-30B-A3B-Thinking into a SWE agent with a pivot stage plus end-to-end agentic RL on SWE-bench.
Learn how to add support for new model architectures in NeMo RL.
Parameter-efficient fine-tuning with LoRA: backend support, Automodel vs Megatron schema comparison, config examples, and recipes.
Extend a model’s context window with YaRN RoPE scaling on the Megatron backend for SFT, GRPO, and other workflows.
Off-policy distillation across mismatched tokenizers — build a (student, teacher) projection matrix and run x-token KD via CUDA-IPC teacher logits.
Choose among colocated IPC, NCCL, sparse delta, and NIXL refit transports.
Use NIXL checkpoint-engine refit to update non-colocated vLLM generation workers from policy workers.
Run async GRPO or PPO via the SingleController path: TransferQueue data plane, pluggable staleness samplers, and streaming trainer.
Advanced Topics#
Deep dive into NeMo RL’s architecture, APIs, and design decisions for scalable RL.
Tools and techniques for debugging distributed Ray applications and RL training runs.
OpenTelemetry traces and rl.* metrics via nemo-lens: span groups, configuration, vLLM tracing, and an OTLP export stack.
Optimize large language models with FP8 quantization for faster training and inference.
Run quantized GRPO and distillation with NVIDIA ModelOpt.
Run W4A4 policy training and per-token vLLM rollout on NVIDIA Blackwell GPUs.
Build and use Docker containers for reproducible NeMo RL environments.
API Reference#
Comprehensive reference for all NeMo RL modules, classes, functions, and methods. Browse the complete Python API with detailed docstrings and usage examples.
Full Documentation Index#
The complete table of contents below lists all pages, including guide, development, and design-doc pages that are not shown in the cards above.
About
Environment Start
E2E Examples
Guides
- Add New Models
- Model Diagnostics
- Supervised Fine-Tuning in NeMo RL
- Direct Preference Optimization in NeMo RL
- Nemotron Omni MPO
- An in-depth Walkthrough of DAPO in NeMo RL
- LoRA (Low-Rank Adaptation)
- An in-depth Walkthrough of CISPO in NeMo RL
- An In-Depth Walkthrough of ProRLv2 in NeMo RL
- Quickstart: Launch a ProRLv2 Run
- DAPO: Dynamic Sampling
- Decoupled local/global advantage normalization
- Reward Shaping: “Stop properly” Penalty (Truncation Penalty)
- Loss: Decoupled (Asymmetric) Clipping
- Loss: Token-level Policy Gradient
- Importance Sampling Correction and MoE Stability
- Full Example Configs
- Practical Overrides
- What to Monitor
- References
- Two-Stage SWE RL for Qwen3-30B-A3B-Thinking
- An In-depth Walkthrough of GRPO in NeMo RL
- Length Penalties for GRPO (NeMo-Gym)
- Binary Rewards Requirement
- Common Config
- Flag Reference
- Per-Prompt Data Format
- Implemented Algorithms
- Metrics
- Practical Notes
- Final Recommendations
- An In-Depth Walkthrough of PPO in NeMo RL
- GRPO on DeepScaler
- Solve a Sliding Puzzle Using GRPO
- Audio Post-training with NeMo RL
- Audio-Visual GRPO with Qwen2.5-Omni-7B
- Reward Model Training in NeMo RL
- Environments for GRPO Training
- DeepSeek-V3
- Model Guides
- Model Quirks
- Train with Async GRPO
- Train with Single-Controller (Async GRPO and PPO)
- Configure the Single-Controller Path
- Reward penalties and effort shaping with token capture
- Checkpointing and Replay Recovery
- Async-RL Knobs and Sampler Modes
- Implementation Structure
- Core components
- 1.
SingleControllerActor(nemo_rl/algorithms/single_controller.py) - 2.
TQReplayBuffer(nemo_rl/algorithms/async_utils/replay_buffer.py) - 3.
RolloutManager.generate_and_push(nemo_rl/experience/rollout_manager.py) - 4. Samplers (
nemo_rl/algorithms/async_utils/staleness_sampler.py) - 5.
_rollout_pumpand_train_pump
- 1.
- Coordination Flow
- Core components
- Relation to Legacy Async GRPO
- Known Missing Features
- Quantization-Aware RL (QARL)
- Overview
- Verified Configurations
- Simulated KV-Cache Quantization
- ModelOpt Layer Spec Toggle
- Quantization-Aware GRPO (QA-GRPO)
- Real-Quant NVFP4 Rollout (W4A4 and W4A16)
- Quantization-Aware Distillation (On-Policy QAD)
- Quantization Parameters
- Megatron Checkpoint Directory
- Differences from FP8 Training
- Supported Quantization Formats
- Exporting Megatron Checkpoints
- Limitations
- Train with Eagle3 Speculative Decoding
- Speculative Decoding Draft Co-Training on Automodel Backend
- YaRN Long-Context Training
- Cross-Tokenizer (X-Token) Off-Policy Distillation
- Weight Refit: Choosing a Transport
- Checkpoint-Engine Refit
- Managed Dynamo generation on Slurm
- Router Replay
- Muon Optimizer
- Automodel Tensor Parallel Accuracy Issue
- Fault Tolerance Launcher Guide
Containers
Development
- CI/CD
- Test NeMo RL
- Documentation Development
- Debug NeMo RL Applications
- Profile GPU with Nsys
- FP8 Quantization in NeMo RL
- Experiment with Custom vLLM
Observability
- Observability
- What’s in this section
- Configuration
- Span Groups
- Preset keywords
RLSpanGroup- Examples
- Per-algorithm span names
- Span tags (categorical attributes)
- Startup: what happens before the first step
- Per-prompt spans
- Coverage gaps
- Resource attributes (process tags)
- Granularity guidance
- Metrics
- The tee
- Training scalars
- Startup phases
- W&B history step axes
- Single-Controller rollout recovery metrics
- Async efficiency metrics (
rl.efficiency.*) - vLLM engine metrics (
rl.vllm.*) - Driver-side generation metrics (
gen_ai.*) - Host memory (
rl.host.memory.*) - Metric vs span tag vs resource attribute
- Filtering across runs
- vLLM Tracing
- Exporting to an OTLP backend
- Extending Instrumentation
- Scope
- Install
- Quick start
- What gets instrumented
- What gets exported
- Related
- What’s in this section
Design Docs
- Design and Philosophy
- Padding in NeMo RL
- Logger
- uv in NeMo RL
- Dependency Management
- Data Format
- Generation Interface
- Colocated PPO streaming
- NemoRL<>TRTLLM Disaggregation Rollout (Experimental)
- Managed Dynamo generation design
- Remote Sparse-Delta vLLM Refit
- Checkpoint Engine Design
- Exporting Checkpoints to Hugging Face Format
- Loss functions in NeMo RL
- Automodel Parallel Plan
- Training Backends
- Sequence Packing and Dynamic Batching
- Environment Variable Precedence in NeMo RL
- NeMo Gym Integration
- ModelOpt Real-Quant Refit Architecture
- End-to-End W4A4 NVFP4 with Per-Token vLLM Rollout
- NCCL Reshard Refit (Experimental)
- DSpark Auxiliary Heads
- Training on text that contains
<image> - Automodel v0.6.0 and Context-Parallel Integration
- Token Capture Lineage Ledger
API Reference
- API Reference
nemo_rl- Subpackages
nemo_rl.environments- Submodules
nemo_rl.environments.vlm_environmentnemo_rl.environments.nemo_gym_multimodal- Module Contents
- Functions
- Data
- API
_NEMO_GYM_IMAGE_ENCODE_MAX_WORKERS_encode_single_image_source()normalize_media_in_examples()_IMAGE_SRC_PREFIXES_looks_like_image_src()_extract_input_images_from_message()_is_trainable_output_item()_has_image_before_first_trainable_output()_index_per_turn_images()_without_initial_media_sources()_VideoConfigValue_LOCAL_VIDEO_METADATA_KEYS_require_video_config_value()_resolve_local_video_path()_extract_static_video_messages()_inject_vllm_mm_processor_kwargs()_remove_vllm_mm_processor_kwargs()_replace_cached_video_frames_with_native_video()_strip_local_media_metadata()_compute_dynamic_prompt_length()_video_to_image_content()_make_overlength_filtered_video_example()nemo_gym_example_to_video_datum_spec()
- Module Contents
nemo_rl.environments.math_environmentnemo_rl.environments.code_jaccard_environmentnemo_rl.environments.nemotron_utils- Module Contents
- Functions
- Data
- API
NEMOTRON_VIDEO_PROCESSOR_NAMES_required_config_value()load_nemotron_video_model_config()_nemotron_video_target_resolution()_resize_and_normalize_nemotron_video_frame()_flatten_nemotron_video_frame_messages()_render_nemotron_video_prompt()_expand_nemotron_video_placeholders()process_nemotron_video_frames()image_placeholder_token_ids_from_tokenizer()get_image_placeholder_token_ids()supports_image_placeholder_run_parity()count_image_placeholder_runs()placeholder_runs_from_token_ids()_is_static_video_turn()verify_static_video_media_alignment()predicted_static_image_num_tokens()RolloutGeometryUnderdetermined_process_single_image_at_num_tokens()reprocess_images_at_rollout_budgets()
- Module Contents
nemo_rl.environments.code_environmentnemo_rl.environments.dapo_math_verifiernemo_rl.environments.nemo_gym_requestnemo_rl.environments.rewardsnemo_rl.environments.nemo_gym_shards- Module Contents
- Classes
- Functions
- Data
- API
NEMO_RL_DICT_CONFIG_KEYSPLACEMENT_STRATEGIESDEFAULT_PLACEMENT_STRATEGYDEFAULT_REPLICASSHARD_NAME_PATTERNGYM_LOG_DIR_KEYGYM_ROUTABLE_KEYSShardConfigErrorShardSetupErrorShardSpecSHARD_SPEC_KEYSShardPlanSHARDING_CONFIG_KEYS_as_plain_dict()_as_string_set()_parse_shard()find_gym_config_entries()parse_shard_plan()apply_shard_overlay()build_route_shard_map()apply_shard_log_dir()
- Module Contents
nemo_rl.environments.nemo_gym- Module Contents
- Classes
- Functions
- Data
- API
NEMO_GYM_ACTOR_FQNNEMO_GYM_GRACEFUL_SHUTDOWN_TIMEOUT_SGYM_SERVER_TYPE_KEYSDEFAULT_SHARD_NAMEDEFAULT_SHARD_CPUSDEFAULT_SHARD_PG_READY_TIMEOUT_SECONDSDEFAULT_SHARD_SPINUP_TIMEOUT_SECONDSDEFAULT_SHARD_DRAIN_TIMEOUT_SECONDS_ROUTED_EXPERTS_DTYPESDEFAULT_INVALID_TOOL_CALL_PATTERNSDEFAULT_THINKING_TAGS_count_structured_response_tokens()_require_resolved_agent_refs()NemoGymCompatibleConfigExternalServiceReadinessTargetConfigExternalServiceReadinessConfigshould_use_nemo_gym()_has_nan_generation_logprobs()_typed_gym_failure()get_nemo_gym_uv_cache_dir()get_nemo_gym_venv_dir()NemoGymConfig_POLICY_SERVER_NAME_NG_ROLLOUT_ID_BODY_KEY_TOKEN_CAPTURE_CONTROL_PREFIX_TOKEN_CAPTURE_CONTROL_ENV_POLICY_API_KEY_ENV_external_staging_backend()extract_external_service_readiness()_probe_external_service()_wait_for_external_services()_detect_invalid_tool_call_and_malformed_thinking()get_pad_dynamic_image_shapes()NemoGymextract_reward_components()build_reward_component_columns()validate_reward_components_match_scalar()setup_nemo_gym_config()build_nemo_gym_config()_build_gym_actor_config()get_nemo_gym_route_name()NemoGymShardSet_shard_instances()as_nemo_gym_shard_set()build_nemo_gym_actors()_build_single_gym_actor()_build_sharded_gym_actors()_spinup_shards_concurrently()_discover_route_shard_map()spinup_nemo_gym_actor()validate_dataset_agent_coverage()_iter_dataset_agent_names()_load_agent_names_from_source()_get_agent_name()
- Module Contents
nemo_rl.environments.utilsnemo_rl.environments.metricsnemo_rl.environments.reward_model_environmentnemo_rl.environments.interfaces
- Submodules
nemo_rl.evalsnemo_rl.algorithms- Subpackages
nemo_rl.algorithms.x_token- Submodules
nemo_rl.algorithms.x_token.token_aligner- Module Contents
- Classes
- Functions
- Data
- API
VISUAL_BYTE_MAP_MULTI_TOKEN_ARTIFACT_FIXES_MULTI_TOKEN_ARTIFACT_FIXES_BY_FIRST_UNICODE_FIXES_SPECIAL_TOKEN_MAPAlignmentPairNativeAlignmentPartNativeAlignmentRegionsAlignmentBatchTokenAlignercanonical_token()_canonicalize_sequence()_normalize_canonical_merge_offsets()_merge_encoding_artifacts()_get_byte_value()_merge_consecutive_bytes()_try_merge_byte_buffer()_PAD_EQUIVALENT_ROLES_role_of()_partition()_pair_specials_by_role()_cluster_same_span()_content_align_offset_cluster()align_by_offsets_cluster()
- Module Contents
nemo_rl.algorithms.x_token.loss_utils- Module Contents
- Classes
- Functions
- Data
- API
Fp32SparseMMchunk_log_prob_sums()chunk_average_finalize()chunk_average_log_probs()slice_sparse_projection_rows()slice_sparse_projection_cols()project_student_to_teacher_vocab()select_teacher_topk_indices()LocalizedAlignmentlocalize_alignment()student_next_token_ce()ce_label_mask()next_token_accuracy()collect_overlapping_teacher_shards()assemble_teacher_logits_from_shards()_try_zero_copy_teacher_logits()rebuild_teacher_full_logits_from_ipc()valid_chunk_mask()parse_projection_file()_SPARSE_PROJECTION_CACHE_TOPK_PROJECTION_CACHEget_sparse_projection_matrix()get_topk_projection()_EXACT_TOKEN_MAP_CACHEbuild_exact_token_map()prepare_xtoken_cross_tokenizer_loss_input()
- Module Contents
nemo_rl.algorithms.x_token.utils
- Package Contents
- Submodules
nemo_rl.algorithms.async_utils- Submodules
nemo_rl.algorithms.async_utils.staleness_sampler- Module Contents
- Classes
- Functions
- Data
- API
_GATE_POLL_SECONDSPromptGroupSamplerTransactionalAdmissionSamplerBaseSamplerWindowedSampler_gated_required_buffer_capacity()_GatedSamplerReadyFirstSamplerWeightFifoSamplerInOrderSamplerWindowedSamplerConfigReadyFirstSamplerConfigWeightFifoSamplerConfigInOrderSamplerConfigCustomSamplerConfigSamplerConfigrequired_buffer_capacity_for_config()_custom_sampler_class()_sampler_class_for_config()sampler_supports_buffer_checkpoint()sampler_supports_training_claims()create_sampler()
- Module Contents
nemo_rl.algorithms.async_utils.trajectory_collector- Module Contents
- Classes
- Functions
- Data
- API
TokenizerType_MAX_NEMO_GYM_STREAM_RETRIES_NEMO_GYM_RETRY_DELAY_BASE_SECONDS_REPLAY_BUFFER_MAX_BACKOFF_SECONDS_WAKE_RETRY_INTERVAL_S_stamped_task_indices()_unanimous_task_index()_caused_by_ray_actor_death()AsyncTrajectoryCollector_calculate_target_weights()_get_next_target_for_generation()set_weight_version()set_generation_window()_should_pause_for_generation_limits()start_collection()is_data_exhausted()get_status()_mark_collection_failed()_collection_loop()_run_collection_loop()_stamp_task_indices()_capture_dataloader_state()_filter_covered_rows()get_checkpoint_dataloader_state()get_checkpoint_state()_process_batch()get_weight_version()check_health()pause()resume()prepare_for_refit()resume_after_refit()wait_for_pending_generations()get_dataloader_state()get_efficiency_metrics()flush_telemetry()_wake_waits()_drain_thread()_may_still_run()_join_until()drain_payload_metrics()_build_rollouts_state()get_rollouts_state()_cleanup_finished_threads()_release_target()_compute_teacher_logprobs()_iter_rollout_groups()_run_rollout_batch_worker()_build_task_index_map()_enqueue_rollout_group()_collect_rollout_batch()
- Module Contents
nemo_rl.algorithms.async_utils.replay_buffer- Module Contents
- Classes
- Functions
- Data
- API
DATA_PLANE_CHECKPOINT_DIRREPLAY_BUFFER_METADATA_FILENAMELEGACY_REPLAY_BUFFER_FILENAMEREPLACEMENT_RESERVE_FILENAMEREPLAY_BUFFER_METADATA_SCHEMA_VERSIONREPLAY_BUFFER_METADATA_STORAGECheckpointMutationKindCHECKPOINT_MUTATION_KINDSDataPlaneCheckpointBarrierTelemetryTQReplayGroupMetadataTQReplayMetadataStateDataPlaneCheckpointMetadatadata_plane_checkpoint_schema_versionsingle_controller_train_stepssingle_controller_trainer_versionsingle_controller_epochpartition_idsampler_namemodereplay_metadata_schema_versionreplay_manifest_digestreplay_group_countrollout_recovery_schema_versionrollout_recovery_payload_sha256rollout_recovery_group_countopd_full_teacher_checkpoints
_canonical_manifest_value()_canonical_manifest_extra_info()replay_manifest_digest()DataPlaneMutationCutDataPlaneCheckpointBarrierPostWriteEnrichmentErrorReplayBufferImpl_rollout_metrics_turn_count_for_diagnostics()add()get_debug_info()get_last_target_weight_already_generated()get_existing_target_weights()_remove_indices()sample()size()get_held_task_indices()clear()state_dict()save_to_path()load_from_path()load_state_dict()_prepare_for_training_step()_is_valid_for_target()_remove_stale_trajectories()_count_for_target()_truncate_to_max_size()get_trajectories_needed()has_complete_batch()_remove_incomplete_target_steps()
ReplayBufferTQReplayBufferset_data_plane_checkpoint_barrier()data_plane_checkpoint_barrierset_post_write_enricher()group_idsreserve()commit()remove_group()clear_staging_keys()commit_finalized()abort()_delete_slot()remove()claim_for_training()training_owned_replay_groups()training_owned_group_ids()release_training_claims()_remove_groups_unlocked()metadata_state_dict()load_state_dict()count_for_target_step()promote_ready_group()size()__len__()_clear_samples_unlocked()
- Module Contents
nemo_rl.algorithms.async_utils.interfaces
- Package Contents
- Submodules
nemo_rl.algorithms.single_controller_utils- Submodules
nemo_rl.algorithms.single_controller_utils.config- Module Contents
- Classes
- Functions
- Data
- API
NativeRolloutFTConfigNemoGymRolloutFTConfigRolloutFailureConfigFleetHealthConfig_GYM_RETRY_STATUSESGenerationRouterConfigWatchdogConfigAsyncRLConfiglog_full_train_datasamplerrollout_failurestall_watchdoggeneration_fleet_healthgeneration_routerrecompute_kv_cache_after_weight_updatesmin_groups_for_streaming_trainmax_inflight_promptsmax_buffered_rolloutsdiagnosticsnum_advantage_workers_reject_renamed_blocks()_check_router_deadline_fits_inside_the_rollout()_check_stall_watchdog_outlasts_rollouts()_reject_relocated_keys()
TokenCaptureConfigTaskSourceRecoveryGranularityRolloutRecoveryConfigRolloutCheckpointConfigMasterConfigis_ppo_run()algo_config()validate_sampler_buffer_capacity()_validate_opd_full_config()_validate_failure_settings()_validate_algo_settings()validate_single_controller_config()AdvantageConfigoutput_fieldreward_fieldtoken_mask_fieldsample_mask_fieldinvalid_tool_call_mask_fieldmalformed_thinking_mask_fieldmask_sample_fieldtruncated_fieldrepeated_batch_fieldspolicy_logprobs_fieldgeneration_logprobs_fieldreference_logprobs_fieldteacher_logprobs_fieldvalues_fieldreturns_fieldprompt_ids_field
- Module Contents
nemo_rl.algorithms.single_controller_utils.rollout_checkpoint- Module Contents
- Classes
- Functions
- Data
- API
ROLLOUT_SNAPSHOT_SCHEMA_VERSIONBOOTSTRAP_COMPATIBILITY_SCHEMA_VERSIONBOOTSTRAP_DIRNAMEBOOTSTRAP_MANIFEST_FILENAMEROLLOUT_SNAPSHOTS_DIRNAMEROLLOUT_SNAPSHOT_MANIFEST_FILENAMERolloutCheckpointAttemptOutcomeROLLOUT_CHECKPOINT_ATTEMPT_OUTCOMESRolloutCheckpointAttemptReasonROLLOUT_CHECKPOINT_ATTEMPT_REASONS_SNAPSHOT_RE_TMP_SNAPSHOT_RE_TRASH_SNAPSHOT_RE_BOOTSTRAP_FINGERPRINT_EXCLUDED_PATHS_path_matches()_drop_excluded_paths()_fsync_file()_fsync_directory()_fsync_tree()_snapshot_sequence()RolloutSnapshotManifestResolvedRolloutCheckpointBootstrapCompatibilityIdentity_normalize_capture_reward_config()bootstrap_compatibility_identity()bootstrap_fingerprint()_MISSING_format_changed_value()_compatibility_differences()_bootstrap_anchor_manifest()prune_bootstrap_snapshots()ensure_bootstrap_anchor()validate_bootstrap_anchor()prepare_snapshot_paths()commit_snapshot()resolve_latest_snapshot()
- Module Contents
nemo_rl.algorithms.single_controller_utils.setup- Module Contents
- Classes
- Functions
- API
SingleControllerActorArgsgen_handletrainer_handleenv_handlestrain_clusterinference_clusterdp_clientdataloaderweight_synchronizeradvantage_estimatorloss_fnrollout_managertq_bufferpartition_idsave_statelast_checkpoint_pathfinalizer_actorsadvantage_actorsdata_plane_checkpoint_metadatapartition_includes_multimodal_fieldsbootstrap_identityrollout_checkpoint_load_metricsstorage_unitsfleet_monitorgeneration_routerteacher_worker_groupsalias_to_group_aliasvalue_handlevalue_loss_fn
_maybe_restore_native_data_plane_checkpoint()_register_single_controller_partitions()_non_colocated_teacher_node_count()_build_clusters()_build_generation()_finish_deferred_generation()_build_trainer()_build_value()_spinup_gym()_generation_max_seq_len()_clamp_max_num_steps()_megatron_train_iters()_maybe_inject_megatron_train_iters()_maybe_attach_fleet_health()_shard_base_urls()_maybe_start_generation_router()_build_advantage_estimator()_build_retry_policy()_load_opd_full_teacher_lm_heads()setup_single_controller()
- Module Contents
nemo_rl.algorithms.single_controller_utils.utils- Module Contents
nemo_rl.algorithms.single_controller_utils.advantage_stage
- Package Contents
- Submodules
nemo_rl.algorithms.loss- Submodules
nemo_rl.algorithms.loss.loss_inputnemo_rl.algorithms.loss.clipped_pgnemo_rl.algorithms.loss.draft- Module Contents
- Classes
- Functions
- Data
- API
DEFAULT_DRAFT_TOKEN_CHUNK_SIZE_DTYPE_HEADER_CODES_dtype_header_code()DraftLossStats_tile_log_normalizers()_tile_distributions()_float64_bits()_tp_assert_projected_metadata_agreement()_cached_tile_distributions_and_cross_entropy()_CachedVocabParallelSoftCE_StreamingVocabParallelSoftCE_SumTensorParallelHiddenGradient_StreamingProjectedVocabParallelSoftCE_resolve_draft_bins()streaming_vocab_parallel_soft_ce()projected_streaming_vocab_parallel_soft_ce()dflash_projected_vocab_parallel_soft_ce()
- Module Contents
nemo_rl.algorithms.loss.wrappernemo_rl.algorithms.loss.utilsnemo_rl.algorithms.loss.loss_functions- Module Contents
- Classes
- Functions
- Data
- API
TensorKL_PENALTY_KEYAPPROX_ENTROPY_KEYLOSS_TEED_METRICSDraftCrossEntropyLossConfigDraftCrossEntropyLossDataDictDraftCrossEntropyLossFnClippedPGLossConfigdisable_ppo_ratiotoken_level_losssequence_level_importance_ratiosratio_clip_minratio_clip_maxratio_clip_creference_policy_kl_penaltyreference_policy_kl_typekl_input_clamp_valuekl_output_clamp_valueuse_kl_in_rewarduse_importance_sampling_correctiontruncated_importance_sampling_typetruncated_importance_sampling_ratiotruncated_importance_sampling_ratio_mintruncated_importance_sampling_adaptive_target_entropytruncated_importance_sampling_adaptive_k_steptruncated_importance_sampling_adaptive_k_maxtruncated_importance_sampling_adaptive_outer_bounduse_on_policy_kl_approximationforce_on_policy_ratioseq_logprob_error_in_lossuse_cispopositive_example_nll_weightmetrics_levelenable_torch_compile
ClippedPGLossDataDictClippedPGLossFn_validate_opd_full_loss_config()NLLLossFnPreferenceLossDataDictPreferenceLossFnDPOLossConfigDPOLossDataDictDPOLossFnMPOLossConfigMPOLossFnDistillationLossConfigDistillationLossDataDictDistillationLossFnMseValueLossConfigMseValueLossFnCrossTokenizerDistillationLossConfiggold_lossxtoken_losstemperaturevocab_topkuncommon_topkreverse_klexact_token_match_onlykl_loss_weightce_loss_scaledynamic_loss_scalingkd_loss_modenormalize_teacher_by_vocabalphasum_weights_metricstudent_vocab_sizeteacher_vocab_sizesprojection_matrix_pathsteacher_weightsteacher_gold_lossteacher_xtoken_loss
CrossTokenizerDistillationLossDataDictCrossTokenizerDistillationLossFnloss_typeinput_type_teacher_is_same_vocab()__call__()_resolve_gold_xtoken()_compute_teacher_kd()_compute_same_vocab_kl()_direct_topk_kl()_direct_full_vocab_kl()_same_vocab_masked_kl()_sum_kd()_averaged_logits_kd()_dp_global_masked_mean()_select_teacher_kd()_teacher_score_inputs()_compute_dynamic_weights()_teacher_weight_score()_compute_p_kl()_compute_gold()_compute_ce()
- Module Contents
nemo_rl.algorithms.loss.interfaces
- Package Contents
- Submodules
- Submodules
nemo_rl.algorithms.grpo_syncnemo_rl.algorithms.dponemo_rl.algorithms.metric_utils- Module Contents
- Classes
- Functions
- Data
- API
SETUP_TIMING_PREFIXREWARD_KEYLOSS_KEYGRAD_NORM_KEYLEARNING_RATE_KEYMEAN_GEN_TOKENS_PER_SAMPLE_KEYTRAINING_TEED_METRICSSetupTimingMetricsgeneration_init_time_sgeneration_init_reserve_time_sgeneration_init_load_time_spolicy_init_time_svalue_init_time_snemo_gym_init_time_scollective_init_time_sweight_sync_time_sparallel_wall_time_sparallel_init_enabledteacher_reservation_time_steacher_model_init_time_steacher_init_time_svllm_checkpoint_engine_init_time_stotal_setup_time_sworker_setup_time_sother_setup_time_sextras_DURATION_SUFFIXESto_metrics_dict()phase_name()phase_seconds()
print_setup_timing_summary()
- Module Contents
nemo_rl.algorithms.sft- Module Contents
nemo_rl.algorithms.single_controller- Module Contents
- Classes
- Functions
- Data
- API
Generationlog_SUPERVISOR_DRAIN_TIMEOUT_S_RolloutCheckpointSaveResult_RolloutCheckpointCut_latest_generation_values()_percentile()_pooled_opd_metrics()_train_fields_for_step()SingleControllerActor_recovering_from_refit_tracerrun()_run_pumps()ping()_log_telemetry_metrics()_record_rollout_timing()_log_rollout_restore_metrics()_maybe_restore_replay_buffer()_maybe_restore_rollout_recovery()_queue_restored_replay_groups_for_regeneration()_load_recovery_prompt()_validate_restored_sampler_cursor()_require_unoccupied_target_step()_rehydrate_rollout_recovery_prompts()_admit_reserved_prompt_groups()_redispatch_restored_rollouts()_validate_replay_inventory()_validate_rollout_recovery_inventory()_maybe_restore_replacement_reserve()_ray_get()_call_dp()_save_data_plane_checkpoint()_request_staging_keys()_cleanup_known_finalization_request_unlocked()_cleanup_known_finalization_request()_discard_committed_group()_finalize_with_actor()_cleanup_consumed_metas_unlocked()_log_data_plane_metrics()_log_data_plane_metrics_impl()_group_ids_from_meta()_rollout_pump()_divert_batch_to_reserve()_drain_reserve_into_steps()_take_replacement()_promote_into_step()_credit_shortfall()_target_groups_for_step()_streaming_ppo_selection_kwargs()_train_pump()_stall_watchdog_pump()_gen_fleet_probe_pump()_probe_generation_fleet()_push_router_membership()_drain_router_failures()_stand_down_refit_deadline()_reconcile_refit_membership()_recovery_window()_recover_from_failed_refit()_refit_participants()_record_refit_landed()_check_env_health()_abort_stale_inflight()_prune_finalizer_state()_capture_reward_settings()_capture_rollout_checkpoint_cut()_write_rollout_checkpoint_sidecars()_save_rollout_checkpoint()_log_rollout_checkpoint_outcome()_rollout_checkpoint_pump()_rollout_telemetry_pump()_log_rollout_throughput_metrics()_collect_and_log_rollout_throughput_metrics()_save_checkpoint()_save_checkpoint_impl()_REFIT_UNWIND_GRACE_S_GENERATION_CONTROL_TIMEOUT_S_refit_await_budget_s()_sync_weights_within()_sync_weights()_value_stage()_value_train_epochs()_advantage_stage()_run_advantage_stage()_absorb_advantage_outcome()_retune_lookahead_versions()
- Module Contents
nemo_rl.algorithms.grpo- Module Contents
- Classes
- Functions
- Data
- API
TokenizerType_maybe_restore_async_replay_buffer_checkpoint()_save_async_replay_buffer_checkpoint()RewardScalingConfigAsyncGRPOConfigRewardPenaltyTokenIdsConfigRewardPenaltyConfig_REWARD_PENALTY_FLAGSGRPOConfignum_prompts_per_stepnum_generations_per_promptmax_num_epochsmax_num_stepsmax_rollout_turnsnormalize_rewardsadvantage_clip_lowadvantage_clip_highuse_leave_one_out_baselineval_periodval_start_atval_batch_sizeval_at_startval_at_endmax_val_samplesval_num_generations_per_promptstop_at_validation_metricstop_at_validation_thresholdskip_reference_policy_logprobs_calculationseedasync_grpooverlong_filteringuse_dynamic_samplingdynamic_sampling_max_gen_batchesbatch_multiplierreward_shapingreward_scalingcalculate_advantages_on_gpuseq_logprob_error_thresholdinvalid_tool_call_advantagemalformed_thinking_advantageadv_estimatordeduplicate_multimodal_datadebug_payload_metricslength_penalty
GRPOSaveState_initial_grpo_save_state()_get_grpo_save_state()_restore_adaptive_loss_state()_update_adaptive_loss_state()_save_adaptive_loss_state()MasterConfig_validate_seq_logprob_error_in_loss()_validate_multimodal_dedup_capability()_needs_hf_refit_handshake()_uses_managed_noncolocated_refit()_shutdown_completed_nemo_gym_startup()setup()dynamic_sampling()scale_rewards()extract_initial_prompt_messages()add_grpo_token_loss_masks_and_generation_logprobs()_resolve_message_level_advantage_penalties()_raise_if_reward_penalties_enabled_without_nemo_gym()_raise_if_length_penalty_enabled_without_nemo_gym()_apply_message_level_advantage_penalties()_apply_configured_message_level_advantage_penalties()_preserve_router_replay_routed_experts()_policy_dtype()_build_async_grpo_train_data()PROMPT_GROUP_IDS_KEY_prompt_group_ids()_trajectory_group_ids()_apply_mask_sample_filter()_should_log_nemo_gym_responses()_write_latest_checkpoint_status()_get_effort_config()_pad_teacher_logprobs()_create_advantage_estimator()_clip_grpo_advantages()refit_policy_generation()_initial_policy_generation_stale()_log_mixed_rewards_and_advantages_information()_placeholder_seq_logprob_error_metrics()_validate_use_kl_in_reward_compat()_resolve_logprob_skip_flags()compute_and_apply_seq_logprob_error_masking()_validation_stop_value()_validation_early_stop_message()_grpo_train_impl()grpo_train()validate()aggregate_rollout_metrics()_startup_pipeline_ready()_raise_if_collector_stopped()async_grpo_train()
- Module Contents
nemo_rl.algorithms.logits_sampling_utilsnemo_rl.algorithms.xtoken_off_policy_distillation- Module Contents
nemo_rl.algorithms.rmnemo_rl.algorithms.opd- Module Contents
- Classes
- Functions
- API
TeacherResourceConfigNonColocatedTeachersConfigOnPolicyDistillationFullConfigOnPolicyDistillationConfig_opd_cfg()is_opd_enabled()is_non_colocated_teachers_enabled()get_opd_full_config()opd_full_payload_field()opd_full_teacher_index_field()teacher_configs_by_index()opd_full_teacher_checkpoints_by_index()_skip_prev_logprobs()assert_prev_logprobs_available()assert_trust_region_supported()resolve_reference_aliases()get_teacher_routing_metrics()TQTeacherLogprobCoordinatorteacher_seq_pad_multiple()_validate_default_teacher_alias()reserve_teacher_clusters()create_teacher_worker_groups()
- Module Contents
nemo_rl.algorithms.reward_functionsnemo_rl.algorithms.mponemo_rl.algorithms.distillationnemo_rl.algorithms.sft_v2- Module Contents
nemo_rl.algorithms.advantage_estimatornemo_rl.algorithms.utils- Module Contents
- Functions
- Data
- API
get_gdpo_reward_component_keys()calculate_kl()calculate_baseline_and_std_per_prompt()calculate_trivial_reward_distributions()surpress_user_warnings()compute_seq_logprob_errors()masked_mean()mask_filtered_logprobs_outside_tokens()masked_var()set_seed()get_tokenizer()maybe_pad_last_batch()print_performance_metrics()log_generation_metrics()WALL_CLOCK_EFFICIENCY_CATEGORIESTHREAD_ACCUMULATED_EFFICIENCY_CATEGORIESEFFICIENCY_CATEGORIESSTEP_WINDOW_WALL_CLOCK_CATEGORIESprint_efficiency_summary()_DRAFT_RATIO_NUM_REfinalize_draft_ratio_metrics()
- Module Contents
nemo_rl.algorithms.ppo- Module Contents
- Classes
- Functions
- Data
- API
TokenizerTypeAsyncPPOConfigPPOConfignum_prompts_per_stepnum_generations_per_promptmax_num_epochsmax_num_stepsmax_rollout_turnsval_periodval_batch_sizeval_at_startval_at_endmax_val_samplesskip_reference_policy_logprobs_calculationseedoverlong_filteringuse_dynamic_samplingdynamic_sampling_max_gen_batchesbatch_multiplierppo_epochscritic_ppo_epochsreward_shapingreward_scalingadv_estimatorpolicy_training_start_stepwarm_start_value_checkpointseq_logprob_error_thresholdinvalid_tool_call_advantagemalformed_thinking_advantageasync_ppovalidate_epoch()validate_async_warmup()
PPOSaveState_default_ppo_save_state()_apply_ppo_seq_logprob_error_masking()MasterConfigsetup()dynamic_sampling()_create_advantage_estimator()CRITIC_LOSS_KEYCRITIC_TEED_METRICS_compute_critic_metrics()ppo_train()_async_ppo_generation_lead_steps()_async_ppo_buffer_max_age()async_ppo_train()validate()
- Module Contents
nemo_rl.algorithms.advantage_actor
- Subpackages
nemo_rl.modelopt- Subpackages
nemo_rl.modelopt.models- Subpackages
nemo_rl.modelopt.models.generation- Submodules
nemo_rl.modelopt.models.generation.vllm_quant_workernemo_rl.modelopt.models.generation.vllm_modeloptnemo_rl.modelopt.models.generation.vllm_quant_patchnemo_rl.modelopt.models.generation.vllm_quant_moe_amaxnemo_rl.modelopt.models.generation.vllm_quant_backend- Module Contents
- Classes
- Functions
- Data
- API
_FUSED_MODELOPT_MOE_SUFFIXES_match_fused_modelopt_moe_weight()_w13_num_shards_from_state_dict_info()_batch_fused_modelopt_moe_weights()_detach_pending_layerwise_weights()_iter_modelopt_quant_modules()_modelopt_layerwise_reload_roots()_require_complete_modelopt_layerwise_reload()VllmQuantInternalWorkerExtension_QUANT_AMAX_SUFFIXES_nrl_w13_num_shards_by_prefix_nrl_modelopt_reload_roots_supports_unquantized_flashinfer_trtllm_refit()maybe_init_zmq()_is_real_quant_model()_get_modelopt_reload_roots()_weight_update_lifecycle()_weight_update_errors_are_fatal()_synchronize_before_ipc_data_ack()prepare_refit_info()_patch_named_parameters_to_include_buffers()_attach_input_quantizer_amax_loaders()_load_weights()get_weight_snapshot()get_quantizer_stats()
VllmQuantInternalWorkerExtensionWithCheckpointEngine
- Module Contents
- Submodules
nemo_rl.modelopt.models.policy- Subpackages
nemo_rl.modelopt.models.policy.workers- Submodules
nemo_rl.modelopt.models.policy.workers.automodel_quant_policy_workernemo_rl.modelopt.models.policy.workers.megatron_quant_policy_worker- Module Contents
- Classes
- Functions
- API
_quant_checkpoint_cache_suffix()_find_other_quant_checkpoint_caches()_warn_if_other_quant_checkpoint_caches()_set_quantization_model_specs()MegatronQuantPolicyWorkermaybe_init_zmq()_quantize()_patch_validate_model_paths()_patch_setup_model_and_optimizer()_restore_modelopt_state_pre_load()hide_tensor_quantizers()enable_forward_pre_hook()disable_forward_pre_hook()disable_quantization()_hide_extra_state()use_reference_model()without_model_config()get_quantizer_stats()generate()save_checkpoint()_use_real_quant_refit()_get_real_quant_mode()_iter_real_quant_refit_params()_find_weight_quantizer()_iter_hf_input_amax_names()_get_enabled_input_amax()_iter_input_quantizer_amax_params()_iter_params_with_optional_kv_scales()
- Module Contents
nemo_rl.modelopt.models.policy.workers.utils
- Submodules
- Subpackages
- Subpackages
- Submodules
nemo_rl.modelopt.utils- Module Contents
- Functions
- Data
- API
MODELOPT_REAL_QUANT_ZMQ_TIMEOUT_MS_QUANT_IGNORE_NAME_SUFFIXESDEFAULT_NVFP4_IGNORENVFP4RealQuantMode_NVFP4_REAL_QUANT_MODES_iter_quant_ignore_suffix_variants()iter_quant_ignore_name_candidates()matches_quant_ignore_pattern()build_vllm_modelopt_nvfp4_config()_resolve_effective_quantizer_formats()_is_float_format()_validate_nvfp4_quantizer_format()resolve_nvfp4_real_quant_mode()resolve_quant_cfg()
- Module Contents
- Subpackages
nemo_rl.weight_sync- Submodules
nemo_rl.weight_sync.megatron_weight_synchronizernemo_rl.weight_sync.nccl_reshard_weight_synchronizernemo_rl.weight_sync.factorynemo_rl.weight_sync.membershipnemo_rl.weight_sync.sglang_weight_synchronizernemo_rl.weight_sync.collective_weight_synchronizernemo_rl.weight_sync.checkpoint_engine_weight_synchronizernemo_rl.weight_sync.checkpoint_engine_confignemo_rl.weight_sync.nccl_reshard_utils- Module Contents
- Classes
- Functions
- Data
- API
MeshInfoRefitCtxLocalParamSpecHFToLocalParamMapRefitBuilderInterfaceCOLUMN_PARALLEL_SUFFIXESROW_PARALLEL_SUFFIXESget_tp_shard_dim()is_expert_param()FFN_PROJ_WEIGHT_SUFFIXESFFN_GROUPED_EXPERT_SUFFIXESis_nccl_reshard_param()_get_expert_tp_shard_dim()_STR_TO_DTYPE_restore_placement()make_nccl_reshard_refit_info_wire_safe()restore_refit_info_placements()build_mesh_info()get_placements()_INDIVIDUAL_EXPERT_REgroup_expert_params_in_metadata()_LAYER_RE_MODEL_PREFIX_RE_extract_layer_prefix()_extract_layer_name()is_blockwise_fp8_param_storage()check_nccl_reshard_refit_support()build_nccl_reshard_refit_info()
- Module Contents
nemo_rl.weight_sync.vllm_remote_sparse_weight_synchronizernemo_rl.weight_sync.xferdtensornemo_rl.weight_sync.ipc_weight_synchronizernemo_rl.weight_sync.xferdtensor_python- Module Contents
- Functions
- Data
- API
_mesh_rank_tensor()_mesh_ranks()_mesh_signature()_mesh_coordinates()_normalize_shard_dim()_placement_signature()_validate_layout()_compute_shard_slices()_rank_regions()_intersect()_local_slices()_region_numel()_local_tensor()_tensor_metadata()_destination_groups()_build_exact_plan()_PLAN_CACHE_PLAN_CACHE_MAX_SIZE_plan_geometry()_SUBCOMM_CACHE_INACTIVE_SUBCOMM_CACHE_PROCESS_GROUP_COMM_IDS_PROCESS_GROUP_FINALIZERS_destroy_subcommunicator()_abort_subcommunicator()abort_xferdtensor_python_subcommunicators()_evict_communicators()_finalize_process_group()_parent_communicator_key()_active_replica_signature()_get_replica_subcommunicator()clear_xferdtensor_python_caches()_validate_local_inputs()_stage_rank_operations()_exchange_exact_overlaps()_broadcast_destination()_xferdtensor_python_impl_v1()_STRIPED_PLAN_CACHE_STRIPED_PLAN_CACHE_MAX_SIZE_ordered_replica_members()_build_striped_targets()_build_striped_transfers()_max_p2p_peer_degree()_region_view_is_contiguous()_remote_transfers_avoid_double_staging()_striped_geometry()_destination_buffer()_stage_striped_operations()_allgather_destination()xferdtensor_python_impl()__all__
- Module Contents
nemo_rl.weight_sync.interfaces
- Package Contents
- Submodules
nemo_rl.utils- Subpackages
nemo_rl.utils.checkpoint_engines- Submodules
nemo_rl.utils.checkpoint_engines.basenemo_rl.utils.checkpoint_engines.nixl
- Submodules
- Submodules
nemo_rl.utils.packed_tensornemo_rl.utils.nsysnemo_rl.utils.weight_transfer_httpnemo_rl.utils.rpc_guardnemo_rl.utils.confignemo_rl.utils.multimodal_payload_metrics- Module Contents
- Functions
- Data
- API
_PENDING_PAYLOAD_METRICS_PENDING_PAYLOAD_METRICS_LOCK_tensor_nbytes()_value_nbytes()_value_segment_count()_typed_content_media_nbytes()_typed_content_media_segment_count()protocol5_serialized_nbytes()collect_multimodal_payload_metrics()collect_sharded_multimodal_payload_metrics()merge_multimodal_payload_metrics()drain_multimodal_payload_metrics()print_multimodal_payload_metrics()
- Module Contents
nemo_rl.utils.sequence_lengthsnemo_rl.utils.cuda_ipcnemo_rl.utils.flops_formulas- Module Contents
- Classes
- Functions
- API
FLOPSConfiggbsenc_seq_lenhslayersffn_hsattention_headshead_dimmoe_router_topkquery_groupsimg_seq_lenimg_himg_win_channelspatch_dimclass_token_lenprojector_typeinp_smodel_patternvocab_sizemodel_channelsvec_in_dimq_lora_rankkv_lora_rankqk_head_dimqk_pos_emb_head_dimv_head_dimmoe_layer_freqmoe_shared_expert_intermediate_sizemoe_ffn_hidden_sizemtp_num_layerscausal_self_attnis_hybrid_modelhybrid_override_patternmamba_state_dimmamba_head_dimmamba_num_groupsmamba_num_headsdsa_indexer_n_headsdsa_indexer_head_dimdsa_indexer_topkdsa_indexer_compute_layers
gpt3()llama()nemotron()mixtral()qwen2()qwen3()bert()transformer()flux()_mla_projection_params()_moe_ffn_params()_mla_moe_linear_flops()_vocab_and_mtp_flops()deepseekv3()_causal_topk_pairs()glm_moe_dsa()_mlp_layer_flops()_non_mla_attn_layer_flops()_mamba_layer_flops()_hybrid_model_flops()nemotronh()
- Module Contents
nemo_rl.utils.fastokensnemo_rl.utils.routed_experts_codecnemo_rl.utils.checkpoint- Module Contents
- Classes
- Functions
- Data
- API
PathLike_finalize_telemetry()_load_megatron_common_state_dict()_load_megatron_sharded_metadata_keys()_is_megatron_optimizer_key()validate_warm_start_checkpoint()PretrainedCheckpointConfigCheckpointingConfig_AUTOMODEL_ONLY_CHECKPOINT_FIELDSCheckpointManagerget_resume_paths()init_tmp_checkpoint()_rename_checkpoint()finalize_checkpoint()begin_finalization()finalize_pending()shutdown()_warn_on_delete_failure()__enter__()__exit__()has_pending_finalizationremove_old_checkpoints()get_best_checkpoint_path()get_latest_checkpoint_path()load_training_info()
_load_checkpoint_history()
- Module Contents
nemo_rl.utils.r3_trace- Module Contents
- Functions
- Data
- API
_TRACE_ENV_TRACE_STEPS_ENV_TRACE_SAMPLES_ENV_TRACE_DIR_ENV_TRACE_MICROBATCHES_ENV_TRACE_VERIFY_FORWARD_ENV_DEFAULT_TRACE_DIR_DEFAULT_TRACE_STEPS_DEFAULT_TRACE_SAMPLES_DEFAULT_TRACE_MICROBATCHES_write_lock_patch_lock_router_replay_patch_depth_original_get_replay_topk_event_counts_contextr3_trace_enabled()r3_trace_verify_forward_enabled()_env_int()_trace_steps()_trace_samples()_trace_microbatches()_next_count()_should_trace_step()_current_context()_torch_rank_info()_trace_path()_write_record()_tensor_sha256()_tensor_preview()_tensor_record()_shape()_valid_sample_record()_length_at()_tensors_equal()_expected_with_missing_route_fallback()_router_replay_action_name()_trace_router_replay_topk_use()_verify_router_replay_forward_context()trace_rollout_payload()trace_tq_fetch_payload()r3_trace_stage()maybe_r3_trace_stage()trace_cp_routed_experts()trace_router_replay_assignment()trace_router_replay_action()
- Module Contents
nemo_rl.utils.weight_transfer_sparse_codec- Module Contents
- Classes
- Functions
- Data
- API
NamedTensorTensorBatchSparseOperationSparseInfoTensorPayloadPreparedTensorPayloadSparseItem_INTEGER_DTYPE_BY_SIZE_TensorPayloadBuilderinteger_dtype_for_element_size()dtype_from_name()sparse_operation()integer_view()encode_sparse_infos()merge_sparse_payloads()sparse_locations_for_item()_encode_explicit_locations()DeltaCompressionTracker
- Module Contents
nemo_rl.utils.logger- Module Contents
- Classes
- Functions
- Data
- API
_rich_logging_configuredWANDB_CALLER_STEP_METRICTELEMETRY_WALL_TIME_METRICWandbConfigSwanlabConfigTensorboardConfigMLflowConfigGPUMonitoringConfigLoggerConfigshould_log_nemo_gym_full_result_tables()LoggerInterfaceTensorboardLoggerWandbLogger_git_artifacts_skip_reason()_log_diffs()_log_code()define_metric()_define_exact_metric_locked()_matching_step_metric()_resolve_event_step_metric()_define_event_metrics_locked()_flush_pending_metrics_locked()_buffer_step_metrics_locked()log_metrics()log_hyperparams()log_table()log_plot()finish()log_histogram()
SwanlabLoggerGpuMetricSnapshotRayGpuMonitorLogger_merge_generation_logger_workers()_summarize_list()MLflowLoggerLoggerflatten_dict()configure_rich_logging()print_message_log_samples()get_next_experiment_dir()log_container_init_timing()
- Module Contents
nemo_rl.utils.timernemo_rl.utils.flops_trackernemo_rl.utils.train_data_dumpnemo_rl.utils.length_penalty- Module Contents
- Classes
- Functions
- Data
- API
logger_ZMAD_MIN_MAD_RELProfileBandChannelName_PROFILE_BAND_CHANNELSLengthPenaltyParamsenabledlength_typetop_percentilereasoning_bonusanswer_bonustotal_bonuslongest_reasoning_penaltylongest_answer_penaltylongest_total_penaltygroup_reasoning_length_penalty_coeffgroup_answer_length_penalty_coeffgroup_total_length_penalty_coeffreasoning_zmad_thresholdreasoning_zmad_penaltyanswer_zmad_thresholdanswer_zmad_penaltytotal_zmad_thresholdtotal_zmad_penaltyprofiled_length_penaltyprofiled_length_n_stdprofiled_length_min_samplespass_rate_length_penalty_weightprofile_band_totalprofile_band_reasoningprofile_band_answergroup_length_penalty_profile_gategroup_length_penalty_profile_gate_channelgroup_length_penalty_profile_gate_fieldgroup_length_penalty_profile_gate_positive_only
ProfileBandChannelProfileBandDefaultsProfileBandConfigLengthPenaltyConfig_NON_BINARY_WARNED_AGENTS_BINARY_REWARD_TOL_is_binary_reward()_extract_reasoning_and_answer_text()apply_group_length_penalties()_resolve_global_profile_band()_merged_profile_band()_apply_profile_band_multipliers()_band_multiplier()_group_length_profile_gate_info()_profile_band_numeric_value()_resolve_agent_params()_zmad_local_outliers()_apply_length_penaltyes_and_penalties()_compute_length_weights()
- Module Contents
nemo_rl.utils.outdated_config_checksnemo_rl.utils.nvmlnemo_rl.utils.tensor_opsnemo_rl.utils.weight_transfer_zmqnemo_rl.utils.memory_trackernemo_rl.utils.grad_normnemo_rl.utils.weight_transfer_stream- Module Contents
- Classes
- Functions
- Data
- API
_STREAM_LOCAL_S3_PART_SIZE_S3_MEMORY_LIMITSparseRefitTransport_SparsePayloadBucket_s3_client()_S3ObjectStoresparse_payload_checksum()decode_sparse_payload()iter_sparse_weight_chunks()_get_manifest_s3_store()sparse_export_chunk_size()_executor()init_sparse_delta_baseline_from_iterator()stream_sparse_delta_payloads()stream_sparse_delta_payloads_via_s3_manifest()download_s3_refit_payload()zstd_compress()
- Module Contents
nemo_rl.utils.prefetch_venvsnemo_rl.utils.venvs
- Subpackages
nemo_rl.experience- Submodules
nemo_rl.experience.reward_penalties- Module Contents
- Classes
- Functions
- Data
- API
has_duplicated_reasoning()has_empty_final_answer()effort_shaping_enabled()is_low_effort()shape_effort_reward()has_unwanted_tokens()RewardChecksCapturePenaltyCAPTURE_PENALTIESEffortRewardSettingsCaptureRewardSettingsRewardLogContextFinalizedRewardparse_reward_log_context()compute_reward_checks()finalize_capture_reward()CAPTURE_PENALTY_METRICSaggregate_capture_reward_metrics()capture_reward_result_tables()
- Module Contents
nemo_rl.experience.rollouts- Module Contents
- Classes
- Functions
- Data
- API
TokenizerType_REWARD_PENALTY_METRICS_SHARED_GENRM_METRICSattach_initial_nemo_gym_image_payloads()_add_multimodal_generation_payload()_reattach_original_multimodal_payloads()_reattach_static_multimodal_payloads_to_result()attach_static_multimodal_payload()_add_r3_fallback_metrics()_mask_sample_flags()_attach_routed_experts_to_message_log_prefix()_find_routed_experts_template()_dummy_routed_experts_for_tokens()backfill_missing_routed_experts()EffortLevelsConfigget_effort_config()_EffortShapingMetrics_terminal_completion_length()_apply_effort_shaping()_effort_shaping_metrics()generate_responses()generate_responses_async()calculate_rewards()run_multi_turn_rollout()async_generate_response_for_sample_turn()run_sample_multi_turn_rollout()RolloutGroupResult_aggregate_multi_turn_rollout_metrics()_run_multi_turn_rollout_async()run_async_multi_turn_rollout()run_async_multi_turn_rollout_groups()_tensorize_by_key()NemoGymRolloutResult_CompletedNemoGymGroup_NemoGymStreamAccumulatorget_nemo_gym_thinking_tags()should_mask_flagged_samples()_get_reward_penalty_config_value()compute_reward_penalty_metrics()_get_reward_penalty_token_id()_get_required_reward_penalty_token_id()_get_reward_penalty_token_ids()_get_required_reward_penalty_token_ids()_infer_single_token_id()resolve_reward_penalty_config()apply_reward_penalties()_prepare_nemo_gym_rows()_bucket_nemo_gym_rows_by_instance()_merge_nemo_gym_instance_streams()_merge_nemo_gym_timing_metrics()_tensorize_nemo_gym_result()run_async_nemo_gym_rollout()run_nemo_gym_rollout_sync()_single_group_reward_diagnostics()_group_reward_diagnostics()_nemo_gym_group_metrics()_LENGTH_LIMIT_INCOMPLETE_REASONSnemo_gym_rollout_hit_max_tokens()_postprocess_single_nemo_gym_group()
- Module Contents
nemo_rl.experience.metric_utilsnemo_rl.experience.sync_rollout_actornemo_rl.experience.rollout_reassemblernemo_rl.experience.route_assembly- Module Contents
- Classes
- Functions
- Data
- API
- Module Contents
nemo_rl.experience.route_plan- Module Contents
- Classes
- Functions
- Data
- API
- Module Contents
nemo_rl.experience.rollout_manager- Module Contents
- Classes
- Functions
- Data
- API
TokenizerTypeRolloutCompletionCallback_contains_post_write_enrichment_error()_nemo_gym_metric_namespace()RolloutOutcomeRolloutRetryPolicyRolloutStatsRolloutTimeouts_classify_generation_failure()_gather_cancelling_siblings()RequestDeadlineRegistry_DeadlineAsyncRolloutImplAsyncNemoGymRolloutImplRolloutManagerstatssuspend_request_deadlines()resume_request_deadlines()recovery_ledgerrecord_finalizer_dropped_prompt()set_data_plane_checkpoint_barrier()_recovery_mutation()telemetry_snapshot()record_canonical_publication()record_recovery_siblings()reserve_prompt_group()mark_prompt_group_admitted()discard_prompt_group()set_weight_version()run_rollout()generate_and_push()generate_for_finalization()_generate_for_finalization_attempt()discard_recovery_group()
- Module Contents
nemo_rl.experience.payloadnemo_rl.experience.failures- Module Contents
- Classes
- Functions
- Data
- API
_AIOHTTP_INFRA_TYPES_CLIENT_RESPONSE_ERROR_MAX_CAUSE_DEPTH_RETRIABLE_HTTP_STATUSESRolloutFailureRolloutInfraFailureRolloutTimeoutGenerationUnavailableNoHealthyShardsGymTransportErrorRolloutDataFailureRolloutRedispatchExhaustedRolloutStallFailureClass_INFRA_TYPES_INFRA_TYPE_NAMEShttp_status_is_infra()_http_status()_is_infra()classify_rollout_failure()
- Module Contents
nemo_rl.experience.rollout_reassembler_actornemo_rl.experience.rollout_recovery- Module Contents
- Classes
- Functions
- Data
- API
ROLLOUT_RECOVERY_SCHEMA_VERSIONSUPPORTED_ROLLOUT_RECOVERY_SCHEMA_VERSIONSROLLOUT_RECOVERY_STATE_FILENAMERolloutRecoveryState_LEDGER_STATE_FIELDS_SIDECAR_STATE_FIELDS_GROUP_STATE_FIELDS_PROMPT_REF_STATE_FIELDS_SIBLING_STATE_FIELDS_ATTEMPT_STATE_FIELDS_reject_unknown_fields()PromptGroupPhaseRecoveryGranularityRolloutAttemptStatusPromptGroupStatusPromptRef_validate_prompt_identity()RolloutAttemptRecordRolloutSiblingRecordPromptGroupRecoveryRecordParsedRolloutRecoveryStateSiblingSealResult_new_attempt()_receipt_staging_keys()RolloutRecoveryLedgergroups()reserve_group()mark_group_admitted()bind_runtime_prompt()prepare_for_restart()_abandon_entire_group()assert_checkpoint_safe()expected_staging_keys()prepare_incomplete_retry()mark_group_dispatched()mark_sibling_sealed()mark_group_sealed()abandon_unsealed()finalization_inputs()mark_finalization_started()mark_finalization_unknown()discard_group()discard_canonical_groups()get_group()__len__()__contains__()state_dict()from_state_dict()load_state_dict()_group_from_state()_require_group()_copy_group()_require_sibling()_require_group_status()
_validate_batch_shortfall()_validate_finalizer_metrics()_validate_finalizer_rewards()build_rollout_recovery_state()parse_rollout_recovery_state()
- Module Contents
nemo_rl.experience.interfaces- Module Contents
- Submodules
nemo_rl.data- Subpackages
nemo_rl.data.xtoken- Submodules
nemo_rl.data.xtoken.native_chat- Module Contents
- Classes
- Functions
- Data
- API
_THINK_PATTERN_IM_START_ASSISTANT_IM_ENDRenderedChatDocument_render_chat_text()_prepare_native_thinking_messages()_final_content_span()_eot_index()_tokenize_chat_text()_reject_embedded_chatml_markers()_render_and_tokenize_chat()_render_native_tool_call()_native_scalar_spans()_native_answer_parts_for_document()
- Module Contents
nemo_rl.data.xtoken.cross_tokenizer_collate
- Submodules
nemo_rl.data.energon- Subpackages
nemo_rl.data.energon.multimodal- Subpackages
nemo_rl.data.energon.multimodal.cookersnemo_rl.data.energon.multimodal.task_encoders- Submodules
nemo_rl.data.energon.multimodal.task_encoders.generic_sftnemo_rl.data.energon.multimodal.task_encoders.medianemo_rl.data.energon.multimodal.task_encoders.base
- Submodules
- Submodules
nemo_rl.data.energon.multimodal.model_familiesnemo_rl.data.energon.multimodal.registrynemo_rl.data.energon.multimodal.packingnemo_rl.data.energon.multimodal.types
- Subpackages
- Submodules
nemo_rl.data.energon.sft_dataloader- Module Contents
- Classes
- Functions
- Data
- API
_V2_STATE_FORMAT_VERSION_set_nvdataset_cache_dir()compact_sample_error_handler()SFTDataLoader_identity_fingerprint()_brief()_identity_differences()EnergonSFTDataLoader_source_config()_loader_config()_v2_topology()_loader_identity()_worker_config()_task_encoder()build_energon_sft_loader()__all__
- Module Contents
nemo_rl.data.energon.config- Module Contents
- Classes
- API
EnergonSourceConfigEnergonPackingOptionsEnergonPackingConfig_EnergonComponentConfigEnergonTaskEncoderConfigEnergonCookerConfigEnergonLoaderConfigmodel_familynum_workersshuffle_buffer_sizemax_samples_per_sequencepacking_buffer_sizebatch_groupingprocessor_adaptertopology_mappertask_encodercookersseed_offsetprefetch_factorcheckpoint_every_secwatchdog_timeout_secondsnvdataset_cache_dircache_pool_max_gbytescache_pool_num_workersgc_collect_every_n_steps
- Module Contents
nemo_rl.data.energon.sft_typesnemo_rl.data.energon.sft_workernemo_rl.data.energon.topology
- Package Contents
- Subpackages
nemo_rl.data.packing- Submodules
nemo_rl.data.packing.algorithmsnemo_rl.data.packing.metrics
- Package Contents
- Submodules
nemo_rl.data.datasets- Subpackages
nemo_rl.data.datasets.preference_datasets- Submodules
- Package Contents
nemo_rl.data.datasets.eval_datasets- Submodules
nemo_rl.data.datasets.eval_datasets.gpqanemo_rl.data.datasets.eval_datasets.mmlunemo_rl.data.datasets.eval_datasets.mmaunemo_rl.data.datasets.eval_datasets.local_math_datasetnemo_rl.data.datasets.eval_datasets.daily_omninemo_rl.data.datasets.eval_datasets.mathnemo_rl.data.datasets.eval_datasets.mmlu_pro
- Package Contents
- Submodules
nemo_rl.data.datasets.response_datasets- Submodules
nemo_rl.data.datasets.response_datasets.numinamathnemo_rl.data.datasets.response_datasets.intentnemo_rl.data.datasets.response_datasets.dapo_mathnemo_rl.data.datasets.response_datasets.openr1_mathnemo_rl.data.datasets.response_datasets.general_conversations_datasetnemo_rl.data.datasets.response_datasets.arrow_text_datasetnemo_rl.data.datasets.response_datasets.oai_format_datasetnemo_rl.data.datasets.response_datasets.nemogym_datasetnemo_rl.data.datasets.response_datasets.avqanemo_rl.data.datasets.response_datasets.clevrnemo_rl.data.datasets.response_datasets.squadnemo_rl.data.datasets.response_datasets.daily_omninemo_rl.data.datasets.response_datasets.refcoconemo_rl.data.datasets.response_datasets.tulu3nemo_rl.data.datasets.response_datasets.geometry3knemo_rl.data.datasets.response_datasets.megatron_sft_packednemo_rl.data.datasets.response_datasets.mmpr_tinynemo_rl.data.datasets.response_datasets.response_datasetnemo_rl.data.datasets.response_datasets.openmathinstruct2nemo_rl.data.datasets.response_datasets.aimenemo_rl.data.datasets.response_datasets.nemotron_cascade2_sftnemo_rl.data.datasets.response_datasets.oasstnemo_rl.data.datasets.response_datasets.deepscalernemo_rl.data.datasets.response_datasets.gsm8knemo_rl.data.datasets.response_datasets.audiomcqnemo_rl.data.datasets.response_datasets.helpsteer3
- Package Contents
- Submodules
- Submodules
nemo_rl.data.datasets.processed_datasetnemo_rl.data.datasets.raw_datasetnemo_rl.data.datasets.utils- Module Contents
- Functions
- Data
- API
TokenizerTypeload_audio_from_file()assert_no_double_bos()pil_to_base64()load_dataset_from_path()resolve_external_dataset_class()_BEHAVIORAL_DATASET_CONFIG_KEYSwarn_on_unsupported_dataset_config_keys()update_single_dataset_config()merge_datasets()extract_necessary_env_names()get_huggingface_cache_path()
- Module Contents
- Package Contents
- Subpackages
- Submodules
nemo_rl.data.dataloadernemo_rl.data.chat_templatesnemo_rl.data.processors- Module Contents
- Classes
- Functions
- Data
- API
TokenizerTypehelpsteer3_data_processor()sft_processor()preference_preprocessor()_NemotronOmniPreferenceProcessorProxyvlm_preference_preprocessor()math_data_processor()math_hf_data_processor()vlm_hf_data_processor()_construct_multichoice_prompt()multichoice_qa_processor()nemo_gym_data_processor()kd_data_processor()chat_kd_processor()PROCESSOR_REGISTRYregister_processor()
- Module Contents
nemo_rl.data.captured_medianemo_rl.data.llm_message_utils- Module Contents
- Functions
- Data
- API
TensorTokenizerType_validated_packed_values()message_log_to_flat_messages()get_keys_from_message_log()add_loss_mask_to_message_log()validate_precomputed_loss_masks()_pad_tensor()_validate_tensor_consistency()batched_message_log_to_flat_message()message_log_shape()get_first_index_that_differs()_tokenize_preformatted_message_log()get_formatted_message_log()remap_dataset_keys()MESSAGE_LOG_BULK_FIELDSdecompose_message_log()attach_message_log_view()reconstruct_message_log()
- Module Contents
nemo_rl.data.deepseek_v4_encoding- Module Contents
- Functions
- Data
- API
bos_tokeneos_tokenthinking_start_tokenthinking_end_tokendsml_tokenUSER_SP_TOKENASSISTANT_SP_TOKENLATEST_REMINDER_SP_TOKENDS_TASK_SP_TOKENSVALID_TASKSsystem_msg_templateuser_msg_templatelatest_reminder_msg_templateassistant_msg_templateassistant_msg_wo_eos_templatethinking_templateresponse_format_templatetool_call_templatetool_calls_templatetool_calls_block_nametool_output_templateREASONING_EFFORT_MAXTOOLS_TEMPLATEto_json()tools_from_openai_format()tool_calls_from_openai_format()tool_calls_to_openai_format()encode_arguments_to_dsml()decode_dsml_to_arguments()render_tools()find_last_user_index()render_message()merge_tool_messages()sort_tool_results_by_call_order()encode_messages()_drop_thinking_messages()_read_until_stop()parse_tool_calls()parse_message_from_completion_text()
- Module Contents
nemo_rl.data.megatron_sft_packed- Module Contents
- Classes
- Functions
- Data
- API
IGNORE_INDEXIDENTITY_TEMPLATENEMOTRON_H_ALIGNED_TEMPLATENEMOTRON_NANO_V2_TEMPLATE_PromptConfig_PROMPT_CONFIGSvalidate_megatron_sft_prompt_format()MegatronSFTPackedDatumSpecMEGATRON_SFT_PACKED_FIELDSMEGATRON_SFT_PACKED_BATCH_FIELDSis_direct_packed_row()direct_packed_cp_granularity()split_megatron_sft_conversations()resolve_megatron_sft_prompt_config()_normalize_token_ids()_tokenize_megatron_sft_conversation()count_conversation_tokens()_resolve_pad_token_id()megatron_sft_packed_preprocessor()
- Module Contents
nemo_rl.data.chat_utilsnemo_rl.data.utilsnemo_rl.data.deepseek_v4_tokenizernemo_rl.data.multimodal_utils- Module Contents
- Classes
- Functions
- Data
- API
VLLM_CONTENT_KEYVLLM_MULTI_MODAL_DATA_KEYVLLM_PROMPT_KEYSIMAGE_CONTENT_TYPESVIDEO_CONTENT_TYPESAUDIO_CONTENT_TYPESMULTIMODAL_CONTENT_TYPESROLLOUT_MATCHED_MEDIA_KEYMEDIA_TAGSMEDIA_TAGS_REVERSEDCACHED_VIDEO_FRAME_MANIFEST_MAGICCACHED_VIDEO_FRAME_MANIFEST_MIMEDEFAULT_MEDIA_EXTENSIONS_PLACEHOLDER_STYLE_PROCESSOR_NAMESMEDIA_TAGS_TO_ALLOWEDMEDIA_TAG_PATTERNloggeruses_image_placeholder()PER_TOKEN_MULTIMODAL_FIELDSPACKED_MULTIMODAL_FIELDSROW_SHAPES_SUFFIXrow_shapes_key()ROW_GEOMETRY_SHAPESROW_GEOMETRY_PREPROCESS_MODEROW_GEOMETRY_PREPROCESS_KWARGSWIRE_MULTIMODAL_FIELDSpresent_multimodal_fields()multimodal_row_tags()reassemble_packed_multimodal()_patchify_segments()_shared_preprocess_spec()PackedTensor__setstate__()broadcast_parts()rebuild_from_broadcast_parts()_preprocess_specdeduplication_enabledlogical_segment_counts_by_row()iter_logical_segments()enable_deduplication()_row_segment_indices()__deepcopy__()as_tensor()__len__()to()to_dtype()slice()empty_like()empty_rows_like()concat()merge_segments()flattened_concat()_row_segments()_shapes_of()row_shapes()to_wire()from_wire()
encode_multimodal_for_wire()UNDECLARED_MULTIMODAL_MODEL_INPUTSget_multimodal_keys_from_processor()get_multimodal_default_settings_from_processor()get_dim_to_pack_along()get_preprocess()extract_multimodal_model_inputs()resolve_to_image()image_size_from_source()image_to_data_url()get_responses_content_part_url()extract_input_media_sources_from_responses_messages()media_sources_equal()_materialize_ragged_pixel_values()_stack_ragged_pixel_values()_restore_tensors()_image_num_tokens_from_processed()attach_image_model_inputs_to_message()attach_processor_media_token_validity_mask()_VIDEO_EXT_TO_MIMEvideo_path_to_data_url()get_media_from_message()load_media_from_message()build_media_token_validity_mask()media_placeholder_token_id_from_chunks()chunks_accept_media_token_validity_mask()image_counts_by_row()attach_media_token_validity_mask()
- Module Contents
nemo_rl.data.collate_fnnemo_rl.data.interfaces
- Package Contents
- Classes
- Data
- API
MegatronSFTDatasetConfigResponseDatasetConfigdataset_namedata_pathchat_keyinput_keyoutput_keysubsetsplitprompt_filesystem_prompt_fileenv_nameprocessordownload_dirsplit_validation_sizeseedmegatron_sftnum_framesvideo_sampling_stylevideo_target_num_patchesvideo_temporal_patch_sizevideo_maintain_aspect_ratiopad_audio_to_hop_lengthmin_generation_tokensmax_samplesimage_max_num_tiles
PreferenceDatasetConfigdataset_namedata_pathprompt_keychosen_keyrejected_keysubsetsplitprompt_filesystem_prompt_filenum_framesvideo_sampling_stylevideo_target_num_patchesvideo_temporal_patch_sizevideo_maintain_aspect_ratiopad_audio_to_hop_lengthmin_generation_tokenssplit_validation_sizelegacy_validation_splitseedmax_samplescache_dirimage_max_num_tiles
DataConfigMMLUEvalDataConfigMMLUProEvalDataConfigAIMEEvalDataConfigGPQAEvalDataConfigMathEvalDataConfigLocalMathEvalDataConfigMMAUEvalDataConfigDailyOmniEvalDataConfigEvalDataConfigType
- Subpackages
nemo_rl.models- Subpackages
nemo_rl.models.automodel- Subpackages
nemo_rl.models.automodel.draft- Submodules
nemo_rl.models.automodel.draft.draft_qwen3nemo_rl.models.automodel.draft.lossnemo_rl.models.automodel.draft.markov_headnemo_rl.models.automodel.draft.hidden_capturenemo_rl.models.automodel.draft.commonnemo_rl.models.automodel.draft.eagle3_llamanemo_rl.models.automodel.draft.checkpoint- Module Contents
- Functions
- Data
- API
DRAFT_CHECKPOINT_DIRNAMEDSPARK_META_FILENAMEDSPARK_OPTIMIZER_GROUP_NAMESoptimizer_layout_record()DRAFT_META_VERSIONdraft_meta_record()draft_checkpoint_dir()save_draft_checkpoint()validate_dspark_checkpoint_meta()load_draft_checkpoint()_draft_meta_from_config()load_checkpoint_with_draft()save_checkpoint_with_draft()
- Module Contents
nemo_rl.models.automodel.draft.setup- Module Contents
- Classes
- Functions
- Data
- API
DSPARK_REQUIRED_CONFIG_FIELDSNATIVE_FLAT_EAGLE3_ARCHSload_draft_hf_config()_adapt_speculators_dspark_config()default_eagle3_aux_layer_ids_vllm()_adapt_speculators_eagle3_config()_adapt_native_flat_eagle3_config()PolicyWithDraftvalidate_dspark_draft_config()build_dspark_draft_model()build_eagle3_draft_model()_load_eagle3_weights()build_policy_and_draft_optimizer()
- Module Contents
nemo_rl.models.automodel.draft.runtime
- Package Contents
- Submodules
- Submodules
nemo_rl.models.automodel.convertnemo_rl.models.automodel.train- Module Contents
- Classes
- Functions
- Data
- API
PostProcessingFunctionPreparedModelForward_build_model_batch()prepare_model_forward()model_forward()extract_logits()need_temperature_scaling()apply_temperature_scaling()apply_top_k_top_p_filtering_for_local_logits()_cp_gather_logits()forward_with_post_processing_fn()automodel_forward_backward()LossPostProcessorLogprobsPostProcessorTopkLogitsPostProcessorFullLogitsPostProcessorScorePostProcessoraggregate_training_statistics()
- Module Contents
nemo_rl.models.automodel.confignemo_rl.models.automodel.data- Module Contents
- Classes
- Functions
- Data
- API
_EXPLICIT_ONLY_FORWARD_KWARGS_accepted_forward_kwargs()drop_explicit_only_kwargs_not_in_forward()_all_image_sizes_equal()filter_multimodal_kwargs_for_model()ProcessedInputsProcessedMicrobatchmake_processed_microbatch_iterator()get_microbatch_iterator()process_microbatch()process_global_batch()check_sequence_dim()
- Module Contents
nemo_rl.models.automodel.router_replay- Module Contents
- Classes
- Functions
- API
ReplayGatevalidate_automodel_router_replay_config()require_automodel_moe_model()enable_routing_replay_in_automodel_kwargs()_decoder_layer_index()_replaying_apply()router_replay_gates()_payload_layers()microbatch_routed_experts()_validated_targets()replay_routes()microbatch_replay_context()
- Module Contents
nemo_rl.models.automodel.checkpointnemo_rl.models.automodel.setupnemo_rl.models.automodel.utils
- Subpackages
nemo_rl.models.generation- Subpackages
nemo_rl.models.generation.trtllm- Subpackages
nemo_rl.models.generation.trtllm.quantization- Submodules
nemo_rl.models.generation.trtllm.quantization.fp8- Module Contents
- Functions
- Data
- API
FP8_BLOCK_SIZEFP8_EXPERT_CHUNK_SIZEMXFP8_BLOCK_SIZEUE8M0_BIASE4M3_MAXROUTED_EXPERTS_ONLY_IGNORE_PATTERNSbuild_quant_config()FP8_BLOCK_QUANT_KWARGSMXFP8_BLOCK_QUANT_KWARGS_EXPERT_PREFIX_FUSED_EXPERT_RE_SPLIT_EXPERT_RE_DENSE_MLP_RE_SPLIT_LINEAR_ATTN_REvalidate_fused_expert_layout()SUPPORTED_MODEL_TYPESvalidate_model_type()validate_routed_experts()configure_fp8_llm_kwargs()configure_fp8_moe_backend()_has_fp8_block_scales()is_fp8_model()is_mxfp8_model()is_quantized_expert_refit()cast_tensor_to_fp8_blockwise()cast_tensor_to_mxfp8_blockwise()_insert_unique()_insert_quantized_projection()clone_mapper_staging_weights()_convert_fused_expert_weight()load_weights()
- Module Contents
- Submodules
- Submodules
nemo_rl.models.generation.trtllm.confignemo_rl.models.generation.trtllm.trtllm_disagg_server- Module Contents
- Classes
- Functions
- Data
- API
- Module Contents
nemo_rl.models.generation.trtllm.trtllm_generation- Module Contents
- Classes
- API
TrtllmGenerationinit_cluster_placement_groups()_plan_engines()_config_with_engine_roles()_engine_key()_get_tied_worker_bundle_indices()_assert_direct_dispatch_allowed()_start_disagg_servers()_run_on_engines()_report_engine_addrs()_report_dp_openai_server_base_urls()_report_device_id()init_collective()generate()generate_async()prepare_for_generation()finish_generation()prepare_refit_info()start_gpu_profiling()stop_gpu_profiling()update_weights_from_collective()update_weights_via_ipc_zmq()invalidate_kv_cache()clear_logger_metrics()get_logger_metrics()shutdown()__del__()
- Module Contents
nemo_rl.models.generation.trtllm.trtllm_worker_async- Module Contents
- Classes
- Functions
- API
_tag_nsys_output()TrtllmAsyncGenerationWorkerImplconfigure_worker()__repr__()_engine_role()is_alive()post_init_async()shutdown()start_http_server()stop_http_server()report_dp_openai_server_base_url()report_http_addr()init_collective_async()prepare_refit_info_async()update_weights_from_collective_async()update_weights_via_ipc_zmq_async()report_device_id_async()_weights_tags()_all_sleep_tags()_resolve_wake_tags()sleep_async()wake_up_async()reset_prefix_cache_async()start_gpu_profiling_async()stop_gpu_profiling_async()generate_async()_build_sampling_params()
TrtllmAsyncGenerationWorker
- Module Contents
nemo_rl.models.generation.trtllm.trtllm_http_server- Module Contents
- Functions
- Data
- API
logger_choice_declares_token_ids()_chat_completion_request_cls()normalize_chat_inputs()build_spliced_prompt_ids()_TOKENIZE_SHADOW_RATE_parse_disaggregated_params()_context_leg_response()_build_reasoning_parser()_build_sampling_params()create_app()_resolve_tool_parser_name()_MSGPACK_REQUEST_HEADER_decode_request_body()_build_tool_parser()_make_parse_tool_calls()_to_int_ids()_build_prompt_token_ids()_compute_splice_inputs()start_server()
- Module Contents
nemo_rl.models.generation.trtllm.trtllm_backend
- Subpackages
nemo_rl.models.generation.megatron- Submodules
nemo_rl.models.generation.megatron.megatron_worker- Module Contents
- Classes
- Functions
- API
_inference_optimized_transformer_layer_spec()_configure_inference_optimized_layer_spec()_resolve_mxfp8_refit_backend()_MegatronRefitTask_MegatronBulkRefitPiece_http_sampling_defaults()_resolve_coordinator_policy()_apply_optional_inference_config_kwargs()_apply_inference_cuda_graph_scope()MegatronGenerationMixinprocessorinference_model_colocated_reshard_plan_image_preprocessing_config_gen_model()_init_inference_engine_state()_get_megatron_inference_wrapper_cls()_wrapper_supports_modality()_inference_model_and_media_parts()_vision_pixel_dtype()_build_image_preprocessing_config()_setup_colocated_cuda_graph_managers()get_inference_cuda_graph_capture_count()_initialize_inference_engine()_start_inference_coordinator()_sleep()_sleep_engine()_wake()_wake_engine()_start_inference_loop_thread()_setup_openai_api_server()_run_async_coordinator_start()finish_generation()prepare_for_generation()report_dp_openai_server_base_url()setup_token_capture()set_rollout_weight_version()_build_sampling_params()_merge_stop_strings()_sample_vision_tensors()_build_prompt_and_multimodal_data()_prepare_data_for_generation()_parse_result_to_batched_data_dict()generate()generate_async()_generate_with_persistent_engine()
MegatronGenerationRefitMixin_init_generation_refit_state()init_collective_mcore_generation()preinit_nvshmem_collective()swap_weights_via_reshard()init_nccl_reshard_comm_groups_generation()_commit_megatron_bulk_refit_piece()_build_destination_hf_to_local_param_map()_prepare_mxfp8_refit()_refresh_flashinfer_mxfp8_weights()_build_generation_refit_tasks()_install_generation_refit_plan()_prepare_destination_refit_info()_prepare_destination_nccl_reshard_refit_info()_destination_nccl_reshard_refit()_write_generation_refit_weight()_load_generation_refit_batch()_update_destination_weights_from_collective()_onload_inference_model()_offload_inference_model()_reshard_into_inference_model()suspend_for_refit()resume_after_refit()
- Module Contents
nemo_rl.models.generation.megatron.config- Module Contents
- Classes
- Functions
- API
resolve_refit_execution_batch_bytes()MediaPromptSpecOverridesMultimodalPromptConfigOverridesMCoreGenerationSpecificArgsexpose_http_serverhttp_server_num_replicasparsersbuffer_size_gbblock_size_tokensmax_tokensmax_requestsmax_model_lennum_cuda_graphsuse_cuda_graphs_for_non_decode_stepscuda_graph_implcuda_graph_sizing_distributioncuda_graph_max_tokensinference_cuda_graph_scopemoe_pad_experts_for_cuda_graph_inferencematerialize_only_last_token_logitsenable_chunked_prefillenable_prefix_cachingasync_sched_modevision_embedding_cache_max_bytesallow_stale_multimodal_embeddingsrefit_backendrefit_execution_batch_bytesnum_speculative_tokensmamba_inference_ssm_states_dtypemamba_inference_conv_states_dtypeprefix_caching_mamba_gbprefix_caching_eviction_policyprefix_caching_coordinator_policyprefix_cache_ttl_secondsprefix_caching_routing_alphavision_model_typeimage_dynamic_resolutionimage_dynamic_resolution_model_lengthimage_dynamic_resolution_rounding_modeimage_dynamic_resolution_resize_modevideo_num_framesvideo_temporal_patch_sizevideo_target_num_patchesvideo_maintain_aspect_ratiomegatron_inference_wrappermultimodal_prompt_configkv_cache_management_modelogging_step_intervallogprobs_modefp8_cfgmodel_overrides
MCoreGenerationConfigmerged_inference_megatron_cfg()dedicated_inference_megatron_cfg()
- Module Contents
nemo_rl.models.generation.megatron.token_capturenemo_rl.models.generation.megatron.megatron_generation- Module Contents
- Classes
- API
MegatronGenerationeffective_megatron_cfg()nvlink_domain_span()init_cluster_placement_groups()frontend_ranks()_rank_placement()reserve_http_server_addresses()validate_settings()verify_served_addresses()uses_native_refitworker_groupshard_liveness_ref()init_collective()update_weights_from_collective()init_nccl_reshard_comm_group()set_refit_membership()_refit_ranked_workers()rebuild_collective()rebuild_nccl_reshard_comm_group()prepare_nccl_reshard_refit_info()nccl_reshard_refit()generate()generate_async()prepare_for_generation()finish_generation()setup_token_capture()set_rollout_weight_version()blocks_training()wake_carries_weight_updates()invalidate_kv_cache()preinit_nvshmem_collective()suspend_for_refit()resume_after_refit()prepare_refit_info()start_gpu_profiling()stop_gpu_profiling()shutdown()__del__()
- Module Contents
nemo_rl.models.generation.megatron.utils
- Package Contents
- Submodules
nemo_rl.models.generation.vllm- Submodules
nemo_rl.models.generation.vllm.vllm_backend- Module Contents
- Classes
- Functions
- Data
- API
loggerWeightUpdateTransportUnsupportedNativeRefitTransportWeightUpdateFinalizerIPCWeightManifestError_detach_pending_layerwise_weights()_refresh_hpc_modules_after_layerwise_reload()_unquantized_flashinfer_trtllm_modules()_reload_target_module_ids()_process_mxfp8_modules_after_native_reload()_model_uses_unquantized_flashinfer_trtllm()_local_shard_slices()_IPCWeightManifest_ReloadWeightPreparerNixlVllmWorkerfix_gemma3_vision_weight_name()_GEMMA4_UNIFIED_MULTIMODAL_WEIGHT_MARKERS_is_gemma4_unified_text_only()_filter_gemma4_unified_multimodal_weights()_tied_embedding_aliases()_drop_tied_embedding_aliases()_read_mtp_layer_weights_from_checkpoint()VllmReshardParamSpecCollectionVllmInternalWorkerExtensionpp_comm_groups_mtp_drafter_weights_from_refit_DRAFTER_OWNER_ATTRS_warned_missing_mtp_drafter_logged_gemma4_unified_drop_sparse_delta_applier_nrl_named_parametershf_to_local_param_map_nrl_layerwise_reload_active_nrl_layerwise_reload_failuremodel_update_group_get_named_parameters()_load_full_hf_weights()_load_hf_weights()_without_tied_embedding_aliases()_prepare_reload_weight_iterator()bind_numa()init_collective()init_nccl_reshard_comm_group()report_device_id()report_node_hostname()get_zmq_address()maybe_init_zmq()prepare_refit_info()prepare_sparse_delta_refit_info()_uses_fp8_kv_cache()_split_policy_and_draft_weights()_trim_vocab_padding()_speculative_method()_get_drafter_model()configure_mtp_drafter_weight_source()_load_draft_weights()_mtp_drafter_refit_enabled()_maybe_refit_mtp_drafter()_maybe_process_mtp_drafter_after_loading()load_mtp_weights_from_disk()_load_weights()_get_sparse_delta_applier()_supports_unquantized_flashinfer_trtllm_refit()_uses_unquantized_flashinfer_trtllm()_unquantized_flashinfer_trtllm_param_ids()_uses_native_layerwise_refit()_uses_deepseek_v4_fp8_refit()_validate_native_layerwise_refit()_reject_unsupported_native_refit()_weight_update_lifecycle()_weight_update_errors_are_fatal()_synchronize_before_ipc_data_ack()_get_reload_weight_preparer()_drain_ipc_reload_sender()_update_weights_via_ipc_zmq_with_reload()update_weights_via_ipc_zmq()update_weights_from_collective()_update_weights_from_collective()update_weights_from_decoded_sparse_payload()synchronize_sparse_refit_device()finish_sparse_delta_refit()prepare_nccl_reshard_refit_info()build_hf_to_local_param_map()_build_hf_to_gen_backend_mapping()nccl_reshard_refit()_nccl_reshard_refit_impl()_receive_and_load_misc_params()cleanup()start_gpu_profiling()stop_gpu_profiling()
VllmInternalWorkerExtensionWithCheckpointEngine
- Module Contents
nemo_rl.models.generation.vllm.draft_utilsnemo_rl.models.generation.vllm.refit_layoutnemo_rl.models.generation.vllm.config- Module Contents
- Classes
- Functions
- Data
- API
VllmRefitTransportNameVllmRefitSelectorVLLM_SPARSE_REFIT_TRANSPORTSREFITTABLE_FP8_KV_CACHE_DTYPESVllmVideoConfigVllmSpecificArgstensor_parallel_sizepipeline_parallel_sizeexpert_parallel_sizegpu_memory_utilizationmax_model_lenskip_tokenizer_initasync_enginevideoload_formatprecisionlogprobs_modefp32_lm_headcap_max_tokens_to_contextis_mxrefit_prequantizequantization_ignored_layer_kwsquantization_ignore_patternskv_cache_dtypeenforce_eagerenable_return_routed_expertsenable_vllm_metrics_loggervllm_metrics_logger_intervaluse_tqdmexpose_http_serverhttp_server_api_key_requiredhttp_server_api_keyhttp_refit_api_key_env_varreset_encoder_cache_after_weight_updatehttp_refit_server_portzmq_refit_server_porthttp_server_serving_chat_kwargstool_parser_pluginenv_varsrefit_with_reload_apireasoning_parser_plugin
vllm_nemotron_h_fp32_lm_head_enabled()VllmDeltaCompressionConfigVllmRefitStorageConfigVllmRefitBaselineConfigVllmRefitTuningConfigVllmSparseRefitConfigVllmNixlRefitConfigVllmCheckpointEnginePluginConfigVllmRefitConfigVllmConfigvalidate_vllm_quantization_config()resolve_vllm_video_config()materialize_vllm_video_config()NVFP4_PERTOKEN_VALIDATED_ENTRY_POINTSparse_nvfp4_pertoken_rollout()normalize_nvfp4_pertoken_policy_config()validate_nvfp4_pertoken_generation()validate_nvfp4_pertoken_model()normalize_vllm_refit_config()
- Module Contents
nemo_rl.models.generation.vllm.refit_loadernemo_rl.models.generation.vllm.collective_rpcnemo_rl.models.generation.vllm.vllm_sparse_refit- Module Contents
- Classes
- Functions
- Data
- API
logger_warn_unauthenticated_refit_server()_StagedSparsePayload_stage_sparse_payload()VllmSparseRefitReceiverset_worker_hostnames()set_async_loop()start_sync_server()shutdown()_enqueue_sparse_payload_apply()_submit_pending_sparse_payloads()_notify_refit_apply_waiters()_collect_refit_apply_results()_refit_collective_response()_refit_collective_rpc()update_weights_from_serialized_sparse_payloads()update_weights_from_staged_sparse_payloads()_flush_queued_sparse_payloads()_prepare_sparse_refit_info()_apply_s3_manifest_payload()_apply_zmq_payload()setup_api_server()report_refit_server_base_url()start_zmq_sparse_refit_relay()configure_zmq_sparse_refit_relay()stop_zmq_sparse_refit_relay()flush_zmq_sparse_refit_relay()_setup_vllm_refit_server()
- Module Contents
nemo_rl.models.generation.vllm.captured_chat_logprobsnemo_rl.models.generation.vllm.vllm_worker_async- Module Contents
- Classes
- Functions
- Data
- API
LOGGERCapturedRequestHTTP_SERVER_PROTECTED_PATH_PREFIXESinstall_http_server_api_key_check()_AsyncLLMHTTPClientVllmAsyncGenerationWorkerImplstart_gpu_profiling()stop_gpu_profiling()_return_routed_experts_enabled()_reserve_port()load_model()_create_engine()_start_vllm_metrics_logger()get_vllm_logger_metrics()drain_latest_vllm_logger_metrics()clear_vllm_logger_metrics()post_init_async()get_reserved_url()report_dp_openai_server_base_url()install_token_capture()setup_token_capture()mooncake_checkpoint()set_rollout_weight_version()_capture_admission()_begin_request_capture()_capture_request_media()_fetch_chain_prefix()_resolve_admission_prefix()_enter_request_prefix()_delta_align_routed_experts()_finish_request_capture()_abort_request_capture()_setup_vllm_openai_api_server()_setup_vllm_server()init_collective_async()generate_async()generate_text_async()report_device_id_async()prepare_refit_info_async()_reset_encoder_cache_after_weight_update()update_weights_via_ipc_zmq_async()update_weights_from_collective_async()init_nccl_reshard_comm_group_async()prepare_nccl_reshard_refit_info_async()nccl_reshard_refit_async()reset_prefix_cache_async()pause_generation_async()resume_generation_async()sleep_async()wake_up_async()shutdown()
VllmAsyncGenerationWorker
- Module Contents
nemo_rl.models.generation.vllm.worker_utilsnemo_rl.models.generation.vllm.metric_names- Module Contents
- Data
- API
PROMPT_TOKEN_COUNTERSGENERATION_TOKEN_COUNTERSPROMPT_LENGTH_HISTOGRAMSGENERATION_LENGTH_HISTOGRAMSREQUEST_SUCCESS_COUNTERSOK_FINISH_REASONSFINISHED_REASON_LABELPROMPT_TOKENS_KEYGENERATION_TOKENS_KEYPROMPT_LENGTH_MEAN_KEYGENERATION_LENGTH_MEAN_KEYGENERATIONS_OK_KEYGENERATIONS_FAILED_KEYVLLM_TEED_METRICSBATCH_DURATION_METRICVLLM_RECORDED_METRICSBATCH_DURATION_KEY
- Module Contents
nemo_rl.models.generation.vllm.video_utils- Module Contents
- Functions
- Data
- API
VideoSamplingStyle_TORCHCODEC_END_OF_STREAM_ERROR_round_video_frame_count()_timestamp_to_video_frame_index()_select_video_frame_count()_compute_video_timestamps()_build_video_metadata()_resolve_cached_video_media_path()build_cached_video_frame_metadata()build_cached_video_frame_data_url()_load_cached_video_frame_manifest()_is_torchcodec_end_of_stream_error()_torchcodec_sample_indices()_find_torchcodec_decodable_frame_count()_decode_torchcodec_video()_load_video_frames_torchcodec_with_metadata()register_torchcodec_vllm_video_loader()load_video_frames_with_metadata()
- Module Contents
nemo_rl.models.generation.vllm.vllm_generation- Module Contents
- Classes
- Functions
- Data
- API
loggerhttp_server_api_key_and_worker_config()_record_vllm_generation_metrics()VllmGenerationvalidate_settings()init_cluster_placement_groups()_get_tied_worker_bundle_indices()_report_device_id()_report_dp_openai_server_base_urls()_collect_reserved_urls()load_and_start()_post_init()setup_token_capture()set_rollout_weight_version()_get_raw_spec_counters()snapshot_step_metrics()get_step_metrics()init_collective()shard_liveness_ref()log_shard_gpu_state()restart_shard()set_refit_membership()_refit_leaders_by_shard()_refit_leader_workers()rebuild_collective()generate()generate_text()_async_generate_base()attach_fleet_health()_next_dp_shard_idx()_generate_on_shard()generate_text_async()generate_async()prepare_for_generation()finish_generation()shutdown()prepare_refit_info()update_weights_via_ipc_zmq()update_weights_from_collective()init_nccl_reshard_comm_group()prepare_nccl_reshard_refit_info()rebuild_nccl_reshard_comm_group()nccl_reshard_refit()start_gpu_profiling()stop_gpu_profiling()_collect_vllm_logger_metrics()get_vllm_logger_metrics()drain_latest_vllm_logger_metrics()clear_vllm_logger_metrics()clear_logger_metrics()get_logger_metrics()drain_latest_logger_metrics()__del__()invalidate_kv_cache()pause_generation_for_refit()resume_generation_after_refit()requires_kv_scale_sync
- Module Contents
nemo_rl.models.generation.vllm.vllm_sparse_deltanemo_rl.models.generation.vllm.patches- Module Contents
- Functions
- Data
- API
VLLM_NEMOTRON_H_FP32_LM_HEAD_ENV_VAR_get_vllm_file()_locked_file_patch()_patch_vllm_init_workers_ray()_patch_vllm_llama_eagle3_own_lm_head()_patch_vllm_tool_parser_namespace_tool()_patch_vllm_ray_executor_v2_tcpstore_port()_patch_vllm_shm_broadcast_bind_retry()_patch_vllm_radio_layerscale_loader()_patch_vllm_radio_native_loader()_patch_vllm_radio_final_layernorm()_patch_vllm_glm_decoder_sequence_parallel_moe()_patch_vllm_moe_routed_experts_capture()_patch_vllm_routed_experts_capture_router_fallback()_patch_vllm_nemotron_h_fp32_lm_head()modelopt_moe_amax_aliases()ensure_vllm_source_compat()_apply_vllm_patches()
- Module Contents
nemo_rl.models.generation.vllm.utils- Module Contents
- Functions
- Data
- API
_format_refit_key_error()R3_MISSING_ROUTE_SENTINELVLLM_LOGPROB_FLOORG_ROUTED_EXPERTS_RANGE_CHECKED_GROUPED_MOE_EXPERT_WEIGHT_SUFFIXESassert_reload_refit_config_supported()is_grouped_moe_expert_weight_name()_placeholder_range_bounds()remap_multimodal_placeholders()_as_routed_experts_tensor()validate_rollout_prompt()format_prompt_for_vllm_generation()pad_and_align_routed_expert_indices()attach_routed_experts_to_chat_response_choices()attach_token_information_to_chat_response_choices()model_dump_chat_response_with_dynamic_message_fields()COUNTER_KEY_SEPHISTOGRAM_SUM_PARTHISTOGRAM_COUNT_PART_KEPT_COUNTER_NAMESencode_counter_key()_is_kept()aggregate_spec_decode_counters()_first_delta()_mean_from_histogram()compute_engine_step_metrics()compute_spec_decode_metrics()GENERATION_WORKER_OVERRIDESresolve_generation_worker_cls()
- Module Contents
nemo_rl.models.generation.vllm.vllm_worker- Module Contents
- Classes
- Functions
- Data
- API
logger_context_capped_max_new_tokens()_maybe_enable_vllm_native_tracing()_resolve_enable_prefix_caching()_merge_fp8_kwargs()_validate_worker_extension_cls()_log_effective_quantization_ignore_patterns()_configure_nvfp4_pertoken_engine_kwargs()BaseVllmGenerationWorker__repr__()configure_worker()_init_config()_refit_with_reload_api_enabled()_load_model()llm()is_alive()_tokenize_prompt_with_bos()_merge_stop_strings()_build_sampling_params()start_gpu_profiling()stop_gpu_profiling()_spec_decode_max_tokens()_request_max_new_tokens()_patch_vllm_nsight_config()_get_raw_spec_counters()report_refit_server_base_url()start_zmq_sparse_refit_relay()configure_zmq_sparse_refit_relay()stop_zmq_sparse_refit_relay()
VllmGenerationWorkerImpl_create_engine()post_init()init_collective()generate()generate_text()report_device_id()prepare_refit_info()update_weights_via_ipc_zmq()update_weights_from_collective()init_nccl_reshard_comm_group()prepare_nccl_reshard_refit_info()nccl_reshard_refit()reset_prefix_cache()sleep()wake_up()shutdown()
VllmGenerationWorker
- Module Contents
nemo_rl.models.generation.vllm.checkpoint_engine- Module Contents
- Classes
- Functions
- Data
- API
NIXL_VLLM_WORKER_NIXL_CONFIG_KEYconfigure_nixl_worker()preinit_nixl_from_vllm_config()resolve_rollout_rank()VllmCheckpointEngineMixincheckpoint_engine_validate_checkpoint_engine_weight_update()checkpoint_engine_total_memory_bytes()_load_hf_weights()init_checkpoint_engine()prepare_checkpoint_engine()init_checkpoint_engine_process_group()finalize_checkpoint_engine()_update_weights_from_checkpoint_engine_async()update_weights_from_checkpoint_engine()
VllmCheckpointEngineRpcMixinVllmAsyncCheckpointEngineRpcMixin
- Module Contents
- Package Contents
- Submodules
nemo_rl.models.generation.dynamo- Submodules
nemo_rl.models.generation.dynamo.managed_runtimenemo_rl.models.generation.dynamo.config- Module Contents
- Classes
- Functions
- Data
- API
VLLM_PACKED_BUFFER_SIZE_BYTESVLLM_PACKED_NUM_BUFFERSDYNAMO_VLLM_FLAGS_VLLM_CFG_STRUCTURAL_VLLM_CFG_MOVED_VLLM_CFG_UNSUPPORTED_VLLM_CFG_MANAGED_RUNTIME_VLLM_CFG_INAPPLICABLE_VLLM_SINGLE_RANK_ONLY_FIELDSDynamoWorkerArgsDynamoFrontendArgsDynamoCfgDynamoVllmConfig_require_nonempty_vllm_config()DynamoConfig
- Module Contents
nemo_rl.models.generation.dynamo.dynamo_generation- Module Contents
- Classes
- Functions
- Data
- API
LOGGER_HTTP_MAX_ATTEMPTS_HTTP_RETRY_DELAY_S_RETRYABLE_HTTP_STATUS_CODES_is_retryable_http_response()_parse_dynamo_completion_response()DynamoGenerationprepare_for_generation()frontend_urlfinish_generation()get_logger_metrics()clear_logger_metrics()get_inference_world_size()get_collective_sender_spec()shutdown()__getstate__()__setstate__()_completion_url()_request_timeout_s()_merge_stop_strings()_prompt_token_ids()_build_completion_request()_allowed_new_tokens()_assert_response_within_context()_post_completion_request()_single_sample_output()generate()generate_async()init_collective()prepare_refit_info()update_weights_via_ipc_zmq()update_weights_from_collective()invalidate_kv_cache()
- Module Contents
nemo_rl.models.generation.dynamo.argumentsnemo_rl.models.generation.dynamo.dynamo_workernemo_rl.models.generation.dynamo.refitnemo_rl.models.generation.dynamo.worker_poolnemo_rl.models.generation.dynamo.http_clientnemo_rl.models.generation.dynamo.venvnemo_rl.models.generation.dynamo.token_wrapper- Module Contents
- Classes
- Functions
- Data
- API
_GYM_TOKEN_METADATA_FIELDS_TOOL_ARGUMENT_MAPPING_ERROR_coerce_token_id_list()_coerce_logprob_list()_strip_gym_token_metadata()_chat_template_kwargs()_request_add_generation_prompt()_apply_chat_template()_render_prompt_token_ids()_render_prompt_token_ids_with_optional_prefix()_latest_tokenized_assistant_index()_derive_required_prefix_token_ids()_normalize_tool_arguments_for_template()_validate_engine_data()_inject_gym_token_metadata()prepare_dynamo_chat_completion_request()DynamoTokenWrapperServer
- Module Contents
nemo_rl.models.generation.dynamo.validate_dynamo_vllm_argsnemo_rl.models.generation.dynamo.metrics
- Package Contents
- Submodules
- Submodules
nemo_rl.models.generation.generation_routernemo_rl.models.generation.engine_supervisornemo_rl.models.generation.constantsnemo_rl.models.generation.fleet_health- Module Contents
- Classes
- Data
- API
ShardState_SERVING_STATES_ABSENT_STATESShardHealthGenerationFleetExhaustedFleetHealthPolicyGenerationFleetHealthmembership_epochshard_countsnapshot()serving_shards()absent_shards()suspected_shards()state_of()serving_base_urls()counts_by_state()as_metrics()record_probe()record_actor_death()condemn_silent_participant()report_failure()report_success()shard_for_base_url()mark_restarting()mark_loaded()mark_weights_partial()mark_restart_failed()record_weight_version()report_refit()retire()raise_if_exhausted()_transition()_refresh_membership()
HealthyShardSelector
- Module Contents
nemo_rl.models.generation.openai_server_utilsnemo_rl.models.generation.interfaces- Module Contents
- Classes
- Functions
- Data
- API
ROUTED_EXPERTS_FALLBACK_DTYPEROUTED_EXPERTS_MISSING_ROUTE_SENTINEL_ROUTED_EXPERTS_DTYPE_NAMES_warn_unsupported_in_flight_refit_pause_once()get_num_routed_experts()resolve_routed_experts_dtype()resolve_routed_experts_dtype_name_for_model()verify_right_padding()ResourcesConfigOptionalResourcesConfigDisaggConfigColocationConfigCheckpointEngineConfigGenerationConfigbackendmax_new_tokenstemperaturetop_ptop_kval_temperatureval_top_pval_top_kmodel_namestop_token_idsstop_stringsbad_wordsignore_eoscolocatedport_range_lowport_range_highuse_async_rollouts_pad_token_id_draft_weights_from_refit_mtp_weights_from_refit_draft_full_refit_debug_payload_metricsdisaggregation
should_use_async_rollouts()GenerationSamplingParamsGenerationDatumSpecGenerationOutputSpecCollectiveSenderSpecagreed_media_columns()reject_unenforceable_refit_deadline()GenerationInterfacevalidate_settings()init_collective()generate()prepare_for_generation()finish_generation()shutdown()pause_generation()continue_generation()restart_shard()shard_liveness_ref()log_shard_gpu_state()requires_kv_scale_syncprepare_refit_info()update_weights_via_ipc_zmq()update_weights_from_collective()get_collective_sender_spec()get_inference_world_size()prepare_nccl_reshard_refit_info()nccl_reshard_refit()attach_fleet_health()setup_token_capture()set_rollout_weight_version()invalidate_kv_cache()pause_generation_for_refit()resume_generation_after_refit()blocks_training()wake_carries_weight_updates()clear_logger_metrics()get_logger_metrics()snapshot_step_metrics()get_step_metrics()drain_latest_logger_metrics()
- Module Contents
- Package Contents
- Subpackages
nemo_rl.models.megatron- Subpackages
nemo_rl.models.megatron.draft- Submodules
nemo_rl.models.megatron.draft.optimizernemo_rl.models.megatron.draft.eaglenemo_rl.models.megatron.draft.hidden_capturenemo_rl.models.megatron.draft.dsparknemo_rl.models.megatron.draft.trainingnemo_rl.models.megatron.draft.step_statenemo_rl.models.megatron.draft.utils- Module Contents
- Classes
- Functions
- Data
- API
StateDictCheckpointLoader_CHECKPOINT_CANDIDATE_NAMES_HF_SNAPSHOT_ALLOW_PATTERNS_HF_SNAPSHOT_IGNORE_PATTERNS_DFLASH_FORBIDDEN_EXPORT_COMPONENTS_MODEL_LAYER_QKV_KEY_PATTERN_CHECKPOINT_LAYER_KEY_PATTERN_EagleLayerLayout_resolve_optional_key()_EagleModelLayout_qkv_head_dims()_interleave_qkv()_deinterleave_qkv()_combine_or_shard_weight_parts()_PendingLayerWeights_get_num_aux_hidden_states()_all_gather_tp_shards()_gather_tp_qkv_weight()_gather_tp_gate_up_weight()_gather_tp_weight_if_needed()_extract_tensor_state_dict()_load_safetensors_file()_load_torch_file()_merge_checkpoint_shards()_load_index_checkpoint()_load_checkpoint_file()_load_checkpoint_from_directory()_load_checkpoint_state()_normalize_hf_key()_parse_layer_checkpoint_key()_get_tp_rank()_build_split_axis_by_parameter()_shard_to_local_tp()_assign_optional_layer_weight()_map_layer_hf_weight()_map_hf_state_to_eagle_state()load_hf_weights_to_eagle()_require_state_tensor()find_draft_owner_chunk()get_attached_draft_model()draft_model_detached()_export_layer_weights_to_hf()export_eagle_weights_to_hf()validate_dflash_export_state_dict()get_policy_lm_head_weight()_get_draft_output_layer()_get_draft_to_target_token_mapping()copy_policy_lm_head_to_draft()DRAFT_GRAD_NORM_GROUPregister_draft_grad_norm_group()build_draft_model()
- Module Contents
- Package Contents
- Submodules
- Submodules
nemo_rl.models.megatron.alignmentnemo_rl.models.megatron.opd_full_capturenemo_rl.models.megatron.train- Module Contents
- Classes
- Functions
- Data
- API
PostProcessingFunction_prepare_padding_mask_for_model()suspend_activation_offload_for_forward_only()model_forward()apply_temperature_scaling()forward_with_post_processing_fn()megatron_forward_backward()LossPostProcessorshould_reduce_loss_across_context_parallel()strip_context_parallel_local_loss_metric()LogprobsPostProcessorTeacherFullPayloadPostProcessorTopkLogitsPostProcessoraggregate_training_statistics()
- Module Contents
nemo_rl.models.megatron.confignemo_rl.models.megatron.commonnemo_rl.models.megatron.hybridepnemo_rl.models.megatron.batch_invariantnemo_rl.models.megatron.memory_savernemo_rl.models.megatron.data- Module Contents
- Classes
- Functions
- API
ProcessedInputsDirectPackedMetadataProcessedMicrobatch_validate_direct_packed_microbatch()make_processed_microbatch_iterator()_get_non_packed_sequence_pad_factor()_pad_sequence_aligned_tensors()get_microbatch_iterator()get_ltor_masks_and_position_ids()_get_direct_packed_bundle_on_this_cp_rank()_prepacked_boundary()_slice_prepacked_for_cp()_prepare_prepacked()process_microbatch()_make_r3_trace_token_identity()_verify_r3_trace_cp_token_alignment()_fill_routed_experts_padding()process_global_batch()_prepare_vlm_batch_for_megatron()_pack_sequences_for_megatron()_shard_routed_experts_for_cp()_get_packed_sequence_alignment_factors()_get_pack_sequence_parameters_for_megatron()_unpack_sequences_from_megatron()get_and_validate_seqlen()
- Module Contents
nemo_rl.models.megatron.router_replay- Module Contents
- Functions
- Data
- API
_ROUTER_REPLAY_VALIDATE_ENV_ROUTER_REPLAY_EXCLUDE_MTP_ENV_MISSING_ROUTE_SENTINEL_MISSING_ROUTE_FALLBACK_PATCH_ATTRrouter_replay_enabled()configure_vllm_for_router_replay()validate_router_replay_config()_iter_model_modules_with_mtp_ancestry()_router_replay_exclude_mtp_enabled()_unwrap_model_config()_global_moe_layer_numbers()router_replay_dimensions()_router_replay_instances_for_model()_local_layer_numbers_for_model()_normalize_routed_experts_for_mcore()_payload_indices_for_moe_layers()_router_replay_validation_enabled()_validate_replay_tensor()_install_missing_route_fallback_patch()_get_tensor_model_parallel_world_size()_get_tensor_model_parallel_rank()_split_for_sequence_parallel()build_router_replay_tensors()build_router_replay_assignments()set_router_replay_forward()set_router_replay_backward()clear_router_replay()clear_global_router_replay_instances()
- Module Contents
nemo_rl.models.megatron.pipeline_parallelnemo_rl.models.megatron.zero_train_gen_mismatch- Module Contents
- Classes
- Functions
- Data
- API
MEGATRON_CORE_REQUIRED_CONFIG_FIELDSTRANSFORMER_ENGINE_MIN_VERSIONFLASH_ATTN_MIN_VERSIONCUTEDSL_MIN_VERSION_ZERO_KL_MEGATRON_REQUIRED_ZERO_KL_GENERATION_REQUIRED_TE_NATIVE_ENV_VARSZeroTrainGenValidationvalidate_zero_train_gen_mismatch()validate_batch_invariant_mode()allow_installed_flash_attn_4()_Tp1LocalLogprob_use_fused_log_softmax_at_tp1()enable_batch_invariant_kernels()validate_zero_train_gen_kl()_validate_required_values()_validate_backend()_validate_platform()_validate_megatron_core_features()_package_version()_first_package_version()_validate_packages()validate_zero_train_gen_model_provider()_validate_precision()
- Module Contents
nemo_rl.models.megatron.community_importnemo_rl.models.megatron.setup- Module Contents
- Classes
- Functions
- Data
- API
_HF_CONFIG_PATCHED_NEMOTRON_OMNI_EXPANDED_SEQUENCE_CONTRACT_patch_hf_config_double_instantiation()_force_sync_optimizer_fp32_from_model()_force_sync_model_from_optimizer_fp32()TokenizerType_OPTIMIZER_DTYPE_KEYS_sync_consumed_samples_on_scheduler_load()_resolve_optimizer_dtype_kwargs()enable_batch_invariant_mode()destroy_parallel_state()configure_refit_environment()_distributed_timeout_minutes()setup_distributed()validate_and_set_config()_canonicalize_hf_config_overrides()_get_hf_config_overrides_hash()_resolve_iter_dir_from_root()_resolve_peft_restore_dir()_validate_peft_restore_config()_create_peft_warm_start_hook()validate_model_paths()validate_megatron_config()setup_model_config()_validate_model_override_conflicts()_merge_model_overrides()_merge_model_override_value()_apply_parallelism_config()_apply_multimodal_config()_apply_moe_config()_apply_mtp_config()_quant_recipe_name()_validate_te_precision_config()_validate_nvfp4_pertoken_precision_recipe()_apply_precision_config()_apply_performance_config()_validate_optimizer_config()_validate_chunking_config()_create_checkpoint_config()_validate_training_config()_validate_dtype_config()_create_megatron_config()_create_draft_pre_wrap_hook()_BRIDGE_SIGNAL_HANDLER_PATCHED_patch_bridge_signal_handler_for_worker_threads()build_inference_model()setup_model_and_optimizer()handle_model_import()setup_reference_model_state()load_teacher_output_layer_weight()finalize_megatron_setup()MoEFloat16Modulemake_policy_like_config()
- Module Contents
- Subpackages
nemo_rl.models.policy- Subpackages
nemo_rl.models.policy.workers- Submodules
nemo_rl.models.policy.workers.base_policy_worker- Module Contents
- Classes
- API
AbstractPolicyWorkermodel_update_grouppp_comm_groupsync_params_before_refit()init_collective()init_nccl_reshard_comm_group()prepare_nccl_reshard_refit_info()nccl_reshard_refit()_refit_transport_state()connect_sglang_rollout_engines()stand_down_refit_watchdog()is_alive()reset_peak_memory_stats()get_gpu_info()report_device_id()get_zmq_address()maybe_init_zmq()get_free_memory_bytes()shutdown()start_gpu_profiling()stop_gpu_profiling()report_node_ip_and_gpu_id()get_reference_policy_logprobs()finalize_async_save()finish_training()
- Module Contents
nemo_rl.models.policy.workers.megatron_remote_sparse_refitnemo_rl.models.policy.workers.automodel_policy_worker- Module Contents
- Classes
- Functions
- API
_refit_tensor_dtype()_module_params_generator()automodel_params_generator()_assert_lora_modules_reachable()_maybe_merge_lora_weight()_maybe_adapt_tensor_to_hf()AutomodelPolicyWorkerImpl__repr__()_get_replica_group()_local_coords()_update_moe_gate_bias_if_supported()_autocast_context()set_rollout_num_gpus_per_engine()train()get_logprobs()score()get_topk_logits()get_full_logits_ipc()release_ipc_buffer()use_reference_model()_add_noise_to_weights()return_state_dict()return_model_config()prepare_refit_info()calibrate_qkv_fp8_scales()stream_weights_via_ipc_zmq()update_weights_to_sglang_colocated()_checkpoint_engine_params()broadcast_weights_for_collective()_broadcast_weights_for_collective()prepare_for_lp_inference()prepare_for_training()finish_inference()offload_before_refit()offload_after_refit()move_optimizer_to_device()move_to_device()move_buffer_to_device()move_to_cuda()move_to_cpu()save_checkpoint()finalize_async_save()load_checkpoint()_init_checkpoint_manager()
AutomodelPolicyWorker
- Module Contents
nemo_rl.models.policy.workers.megatron_policy_worker- Module Contents
- Classes
- Functions
- Data
- API
logTokenizerType_should_use_router_replay()_model_self_packs_for_cp()_model_self_packs_mtp_loss_mask()_model_slices_context_parallel_inputs()_unwrapped_chunks()_model_has_chunkwise_cp()_model_needs_router_padding_mask()_model_media_placeholder_token_id()_model_accepts_media_token_validity_mask()_estimate_refit_tensor_size_in_bytes()_is_quantized_refit_source()_RefitSource_dequantize_refit_source_group()_dequantize_refit_source()_get_refit_task_source()MegatronReshardParamSpecCollection_collect_mtp_hf_layer_names()_collect_local_refit_hf_names()_meta_tensor_alloc_context()_reserved_http_server_port_for_rank()MegatronPolicyWorkerImplis_refit_destination_train_step_state_remote_sparse_refit_async_checkpoint_cuda_cache_active__repr__()_local_coords()_routed_experts_dimensions()_get_replica_group()configure_worker()enable_forward_pre_hook()disable_forward_pre_hook()_forward_pre_hook_enabled()_disable_forward_pre_hook_until_next_train_step()_restore_first_train_step_param_sync()_copy_main_params_to_param_buffer()_uses_mxfp8_overlap_shared_param_buffer()_get_model_extra_state_dict()_restore_model_extra_state_dict()_normalize_in_loss_seq_filter()train()_compute_moe_grad_scale()_set_moe_grad_scale_func()get_reference_policy_logprobs()_split_step_state_init()_assert_step_open()_log_gpu_mem()_restore_saved_mcore_hooks()begin_train_step()train_microbatch()_train_microbatch_body()finish_train_step()_finish_train_step_body()abort_train_step()get_logprobs()_resolve_output_layer_owner()load_opd_full_teacher_lm_head()_load_opd_full_teacher_lm_head_from_path()_move_opd_full_teacher_lm_head()_release_opd_full_teacher_lm_head()_stage_opd_full_teacher_lm_head_for_training()get_logprobs_with_full_payload()_apply_state_dict_to_model()use_reference_model()get_topk_logits()_prepare_source_refit_info()prepare_refit_info()enable_refit_prequantize()_maybe_prequantize_param()update_weights_from_collective()_update_destination_weights_from_collective_guarded()_collect_mtp_metrics()_set_mtp_grad_scale_func()_scale_mtp_param_grads()_get_model_config()init_remote_sparse_delta_baseline()stream_remote_sparse_weights()_require_remote_sparse_refit()finish_remote_sparse_delta_sync()_is_fp8_export()_build_refit_conversion_tasks()_generation_needs_logical_weights()_build_bulk_refit_conversion_tasks()_calculate_refit_param_info()_iter_logical_refit_conversion_tasks()_nvfp4_pertoken_rollout_cfg()maybe_init_zmq()_iter_params_with_optional_kv_scales()_iter_local_hf_param_shards()_iter_sglang_hf_weight_buckets()update_weights_to_sglang_colocated()connect_sglang_rollout_engines_distributed()update_weights_to_sglang_distributed()stream_weights_via_ipc_zmq()broadcast_weights_for_collective()_broadcast_weights_for_collective()_build_layer_to_pp_stage()_prepare_source_nccl_reshard_refit_info()prepare_nccl_reshard_refit_info()_build_expert_groups()_build_source_hf_to_local_param_map()build_hf_to_local_param_map()nccl_reshard_refit()_nccl_reshard_refit_guarded()_nccl_reshard_refit()_broadcast_misc_params_packed()prepare_for_lp_inference()_build_colocated_inference_model()pause_train_step_with_offloading()prepare_for_training()finish_inference()_clear_fp8_caches()sync_params_before_refit()offload_before_refit()_clear_rope_and_moe_dispatcher_caches()offload_after_refit()move_model()move_optimizer()save_checkpoint()_requires_nvrx_cuda_cache_release()finalize_async_save()load_checkpoint()check_tensor_parallel_attributes()calibrate_qkv_fp8_scales()
MegatronPolicyWorker
- Module Contents
nemo_rl.models.policy.workers.patchesnemo_rl.models.policy.workers.checkpoint_engine
- Submodules
- Submodules
nemo_rl.models.policy.teacher_worker_groupnemo_rl.models.policy.tq_policy- Module Contents
- Classes
- Functions
- Data
- API
_aggregate_train_results()loggerTQPolicyload_data_plane_checkpoint()shutdown()prepare_step()prepare_val_partition()discard_samples()finish_step()collect_data_plane_snapshots()add_data_plane_snapshot_source()get_data_plane_step_metrics()_with_route_fields()_logprob_dispatch()get_logprobs_from_meta()get_reference_policy_logprobs_from_meta()train_from_meta()begin_train_step()pause_train_step_with_offloading()train_microbatches_from_meta()train_placed_microbatches()_stamp_placed_pad_seqlen()_dispatch_train_microbatches()finish_train_step()abort_train_step()
- Module Contents
nemo_rl.models.policy.lm_policy- Module Contents
- Classes
- Functions
- Data
- API
PathLike_DIRECT_PACKED_SFT_REQUIRED_KEYS_aggregate_megatron_flops_metrics()Policydata_parallel_sizerun_all_workers_single_data()run_all_workers_multiple_data()init_collective()init_collective_mcore_generation()preinit_nvshmem()swap_weights_via_reshard()_shard_for_logprob()_shard_for_train()_report_sharded_payload()get_logprobs()get_reference_policy_logprobs()get_topk_logits()get_full_logits_ipc()release_ipc_buffer()train()generate()score()prepare_for_generation()finish_generation()prepare_for_training()prepare_for_lp_inference()invalidate_kv_cache()prepare_refit_info()enable_refit_prequantize()finish_inference()finish_training()calibrate_qkv_fp8_scales()get_free_memory_bytes()stream_weights_via_ipc_zmq()connect_sglang_rollout_engines()update_weights_to_sglang_colocated()connect_sglang_rollout_engines_distributed()update_weights_to_sglang_distributed()broadcast_weights_for_collective()init_nccl_reshard_comm_group()prepare_nccl_reshard_refit_info()nccl_reshard_refit()sync_params_before_refit()offload_before_refit()offload_after_refit()offload_to_cpu()save_checkpoint()finalize_async_save()shutdown()__del__()start_gpu_profiling()stop_gpu_profiling()print_node_ip_and_gpu_id()
- Module Contents
nemo_rl.models.policy.draft_confignemo_rl.models.policy.utils- Module Contents
- Classes
- Functions
- Data
- API
DETERMINISTIC_ENV_VARSenable_deterministic_algorithms()IPCProtocolPOLICY_WORKER_OVERRIDES_NEMOTRON_H_MODEL_TYPES_NEMOTRON_H_ARCHITECTURESresolve_policy_worker_cls()_normalize_model_type()_get_config_model_type()_get_config_architectures()_is_nemotron_h_model_config()_describe_model_config()validate_fp32_lm_head_config()is_vllm_v1_engine_enabled()get_gpu_info()configure_dynamo_cache()get_runtime_env_for_policy_worker()get_megatron_checkpoint_dir()get_handle_from_tensor()ensure_teacher_ipc_buffer()aggregate_per_sample_handles()calculate_aligned_size()stream_weights_via_ipc_zmq_impl()_REBUILD_CUDA_TENSOR_ARG_DEVICE_INDEX_REBUILD_CUDA_TENSOR_ARG_STORAGE_HANDLE_INDEXrebuild_cuda_tensor_from_ipc()_derive_engine_gpu_offsets()connect_colocate_topology()_check_weight_sync_results()iter_named_tensor_buckets()send_hf_buckets_via_ipc_actor_impl()init_process_group()connect_rollout_engines_from_distributed()disconnect_rollout_engines_from_distributed()broadcast_hf_buckets_via_distributed_impl()
- Module Contents
nemo_rl.models.policy.interfaces- Module Contents
- Classes
- API
LogprobOutputSpecReferenceLogprobOutputSpecScoreOutputSpecTopkLogitsOutputSpecTeacherFullPayloadOutputSpecPolicyInterfaceColocatablePolicyInterfacecfginit_collective()sync_params_before_refit()offload_before_refit()offload_after_refit()offload_to_cpu()prepare_refit_info()enable_refit_prequantize()stream_weights_via_ipc_zmq()connect_sglang_rollout_engines()update_weights_to_sglang_colocated()connect_sglang_rollout_engines_distributed()update_weights_to_sglang_distributed()broadcast_weights_for_collective()prepare_nccl_reshard_refit_info()nccl_reshard_refit()prepare_for_lp_inference()
- Module Contents
- Package Contents
- Classes
- Functions
- Data
- API
_patch_transformers_tokenizer_class_set()LoRAConfigDisabledLoRAConfigAutomodelBackendConfigAutomodelFreezeConfigAutomodelKwargsAutomodelConfigDisabledMoEParallelizerOptionsAutomodelCheckpointConfigAutomodelConfigSequencePackingConfigDisabledSequencePackingConfigRewardModelConfigMegatronPeftConfigDisabledMegatronPeftConfigMegatronOptimizerConfigMegatronSchedulerConfigMegatronDDPConfigFp8ConfigFp4ConfigMegatronConfigDisabledMegatronCheckpointConfigMegatronConfigenabledenv_varsmodel_overridesempty_unused_memory_levelactivation_checkpointingrecompute_granularityrecompute_modulestensor_model_parallel_sizepipeline_model_parallel_sizenum_layers_in_first_pipeline_stagenum_layers_in_last_pipeline_stagecontext_parallel_sizeradio_force_eval_moderadio_force_cpe_eval_modefreeze_vision_modelfreeze_vision_projectionfreeze_sound_encoderfreeze_sound_projectionrecompute_visionvision_recompute_granularityvision_recompute_methodvision_recompute_num_layerspipeline_dtypesequence_parallelfreeze_moe_routerfreeze_vision_encoderfreeze_vision_projectorfreeze_audio_encoderfreeze_audio_projectormoe_router_dtypemoe_router_load_balancing_typemoe_router_bias_update_ratemoe_permute_fusionexpert_tensor_parallel_sizeexpert_model_parallel_sizedefer_fp32_logitsapply_rope_fusionbias_activation_fusionforce_reconvert_from_hfattention_backendmoe_per_layer_loggingmoe_enable_deepepmoe_token_dispatcher_typeinference_moe_token_dispatcher_typeinference_grouped_gemm_backendinference_flashinfer_mxfp8_token_capacitymoe_router_num_groupsmoe_router_group_topktransformer_implcuda_graph_implcuda_graph_modulescuda_graph_warmup_stepsmoe_pad_experts_for_cuda_graph_inferencemoe_shared_expert_overlapfine_grained_activation_offloadingoffload_modulesuse_gloo_process_groupsdistributed_timeout_minutesmoe_grouped_gemmmoe_flex_dispatcher_backendmoe_hybridep_num_smsmoe_hybridep_prepad_packed_inputshybridep_num_ranks_per_nvlink_domainhybridep_use_mnnvlpeftoptimizerschedulerdistributed_data_parallel_configcheckpointgradient_accumulation_fusionuse_fused_weighted_squared_reluuse_fused_linear_logprobsfused_linear_logprobs_chunk_sizefp32_lm_headmtp_num_layersmtp_loss_scaling_factortrain_itersmtp_use_repeated_layermtp_detach_headsclear_memory_caches_before_refitfp8_cfgfp4_cfgfirst_last_layers_bf16num_layers_at_start_in_bf16num_layers_at_end_in_bf16te_precision_config_filefreeze_configbatch_invariant_modebatch_invariant_backendbatch_invariant_collectiveflash_attention_versionzero_train_gen_mismatch
BLOCK_DRAFT_ALGOSDRAFT_ALGOSTokenizerConfigPytorchOptimizerConfigSinglePytorchSchedulerConfigSinglePytorchMilestonesConfigSchedulerMilestonesDynamicBatchingConfigDisabledDynamicBatchingConfigRouterReplayConfigDisabledRouterReplayConfigOnPolicyDistillationFullTransportPolicyConfigmodel_nametokenizertrain_global_batch_sizetrain_micro_batch_sizeoffload_optimizer_for_logproblogprob_batch_sizelogprob_chunk_sizegenerationgeneration_batch_sizeprecisionreward_model_cfgautomodel_cfgmegatron_cfgdraftpretrained_checkpointon_policy_distillation_fullrouter_replayhf_config_overridesdynamic_batchingsequence_packingmake_sequence_length_divisible_bymax_total_sequence_lengthmax_grad_normrefit_buffer_size_gboffload_policy_before_refitoffload_optimizer_for_refitoptimizerschedulerquant_cfgquant_calib_dataquant_calib_sizequant_batch_sizequant_sequence_lengthdisable_modelopt_layer_specis_vlmworker_extension_cls_fqn
- Subpackages
nemo_rl.models.value- Subpackages
nemo_rl.models.value.workers- Submodules
nemo_rl.models.value.workers.automodel_value_workernemo_rl.models.value.workers.megatron_value_worker
- Submodules
- Submodules
nemo_rl.models.value.config- Module Contents
- Classes
- API
ValueConfigmodel_nametokenizertrain_global_batch_sizetrain_micro_batch_sizelogprob_batch_sizeprecisionreward_model_cfgautomodel_cfgmegatron_cfghf_config_overridesdynamic_batchingsequence_packingmake_sequence_length_divisible_bymax_total_sequence_lengthmax_grad_normdequantize_base_checkpointoptimizerscheduler
- Module Contents
nemo_rl.models.value.lm_valuenemo_rl.models.value.tq_valuenemo_rl.models.value.interfaces
- Package Contents
- Subpackages
nemo_rl.models.huggingface
- Subpackages
nemo_rl.distributed- Submodules
nemo_rl.distributed.virtual_cluster- Module Contents
- Classes
- Functions
- Data
- API
loggerRAY_CLUSTER_SOURCE_ATTRRAY_CLUSTER_EXTERNALRAY_CLUSTER_REUSED_LOCALRAY_CLUSTER_STARTED_LOCAL_WORKER_PROCESS_SETUP_HOOKClusterConfigdir_pathgit_rootPY_EXECUTABLESuv_py_executable()DEFAULT_GENERATION_ROUTER_PORT_RANGE_LOWDEFAULT_GENERATION_ROUTER_PORT_RANGE_HIGHDEFAULT_GENERATION_PORT_RANGE_LOWDEFAULT_GENERATION_PORT_RANGE_HIGHDEFAULT_DYNAMO_CONTROL_PORT_RANGE_LOWDEFAULT_DYNAMO_CONTROL_PORT_RANGE_HIGHDEFAULT_DYNAMO_HTTP_PORT_RANGE_LOWDEFAULT_DYNAMO_HTTP_PORT_RANGE_HIGHDEFAULT_DYNAMO_SYSTEM_PORT_RANGE_LOWDEFAULT_DYNAMO_SYSTEM_PORT_RANGE_HIGHDEFAULT_GYM_PORT_RANGE_LOWDEFAULT_GYM_PORT_RANGE_HIGHDEFAULT_VLLM_PORT_RANGE_LOWDEFAULT_VLLM_PORTS_PER_ENGINEDEFAULT_DISAGG_FRONTEND_PORT_RANGE_LOWDEFAULT_DISAGG_FRONTEND_PORT_RANGE_HIGHDEFAULT_SGLANG_ROUTER_PORT_RANGE_LOWDEFAULT_SGLANG_ROUTER_PORT_RANGE_HIGHDEFAULT_SGLANG_PROMETHEUS_PORT_RANGE_LOWDEFAULT_SGLANG_PROMETHEUS_PORT_RANGE_HIGHDEFAULT_MASTER_PORT_RANGE_LOWDEFAULT_MASTER_PORT_RANGE_HIGHDEFAULT_DATA_PLANE_PORT_RANGE_LOWDEFAULT_DATA_PLANE_PORT_RANGE_HIGHNVLINK_DOMAIN_PREFIXTOPO_RANK_KEYNVLINK_DOMAIN_UNKNOWNTOPO_RANK_UNKNOWN_get_node_ip_and_free_port()_get_node_ip_local()_bind_socket_in_range()_get_free_port_local()_get_free_consecutive_ports_local()_reserve_data_plane_ports()init_ray()_init_ray()_get_gpu_id_info()get_reordered_bundle()ResourceInsufficientErrorget_ray_cluster_topology()select_segment_nodes()prepare_segment_topology()_sort_bundle_indices_by_topology()RayVirtualCluster
- Module Contents
nemo_rl.distributed.model_utils- Module Contents
- Classes
- Functions
- API
_compute_distributed_log_softmax_with_grad()_compute_distributed_log_softmax()_compute_distributed_selected_logprobs()DistributedLogprobChunkedDistributedLogprobDistributedLogprobWithSamplingChunkedDistributedLogprobWithSamplingChunkedDistributedGatherLogprob_tp_target_logprobs()get_cp_sharded_next_token_logprobs()from_parallel_logits_to_logprobs()from_parallel_logits_to_logprobs_packed_sequences()_get_tokens_on_this_cp_rank()allgather_cp_sharded_tensor()_AllReduceSumgroup_all_reduce_sum_with_grad()group_all_reduce_sum()AllGatherCPTensorcp_shift_next()vocab_parallel_log_softmax()vocab_parallel_full_log_softmax()vocab_parallel_gather_columns()vocab_parallel_argmax()get_logprobs_from_vocab_parallel_logits()get_next_token_logprobs_from_logits()distributed_vocab_topk()gather_logits_at_global_indices()get_distillation_topk_logprobs_from_logits()ChunkedDistributedEntropyChunkedDistributedCrossEntropyToFixedLogitsChunkedDistributedReverseKLToFixedLogits_entropy_weight()_cross_entropy_weight()_reverse_kl_weight()_chunked_distributed_student_teacher_reduction()_chunked_distributed_student_teacher_backward()_student_teacher_log_softmax_chunk()_validate_student_teacher_logits()from_parallel_hidden_states_to_logprobs()ChunkedDistributedHiddenStatesToLogprobspatch_gpt_model_forward_for_linear_ce_fusion()_gpt_forward_with_linear_ce_fusion()all_to_all_vp2sq()all_to_all_sq2vp()to_local_if_dtensor()
- Module Contents
nemo_rl.distributed.refit_watchdog- Module Contents
- Classes
- Functions
- Data
- API
- Module Contents
nemo_rl.distributed.held_portnemo_rl.distributed.collectivesnemo_rl.distributed.actor_environmentsnemo_rl.distributed.named_shardingnemo_rl.distributed.ray_actor_environment_registrynemo_rl.distributed.batched_data_dict- Module Contents
- Classes
- Functions
- Data
- API
DictT_COUPLED_MULTIMODAL_KEYS_prepare_multimodal_sharing()SequencePackingArgsDynamicBatchingArgs_select_nested_rows()BatchedDataDict_PIXEL_DTYPE_CAST_KEYSget_multimodal_dict()from_batches()all_gather()chunk()reorder_data()shard_by_batch_size()get_batch()slice()repeat_interleave()truncate_tensors()make_microbatch_iterator_with_dynamic_shapes()get_microbatch_iterator_dynamic_shapes_len()make_microbatch_iterator_for_packable_sequences()get_microbatch_iterator_for_packable_sequences_len()make_microbatch_iterator()sizeto()select_indices()get_dict()
SlicedDataDict
- Module Contents
nemo_rl.distributed.numa_utilsnemo_rl.distributed.worker_groupsnemo_rl.distributed.ray_worker_setupnemo_rl.distributed.stateless_process_groupnemo_rl.distributed.worker_group_utils
- Submodules
nemo_rl.data_plane- Subpackages
nemo_rl.data_plane.adapters- Submodules
nemo_rl.data_plane.adapters.mooncake_ssd_offload- Module Contents
- Functions
- Data
- API
LOGGERREQUIRED_ENV_dir_lock_fd_offloading_store_set_upNO_AVAILABLE_HANDLEPUT_WAIT_S_FIRST_BACKOFF_SPUT_BACKOFF_MAX_SEVICTION_COUNTER_COUNTER_LINE_watch_stopSWEEP_INTERVAL_S_SWEEP_BATCH_TENANT_PREFIX_sweep_stopmaster_args()install()wait_for_memory_on_put()upsert_waiting_for_memory()_pick()require_offloading_store()_hold_dir_lock()_remove_stale_dirs()remove_dir()_file_key()sweep_cleared_files()_stamp()_start_sweep()disk_evictions()watch_disk_evictions()watch_master_disk_evictions()
- Module Contents
nemo_rl.data_plane.adapters.localnemo_rl.data_plane.adapters.noopnemo_rl.data_plane.adapters.transfer_queue- Module Contents
- Classes
- Functions
- Data
- API
LOGGER_get_local_node_ip()rdma_devices()_mooncake_transport_config()_STAGING_SLOT_TIMEOUT_S_memlock_limit()_register_checked()_NativeStagingPool_StagingPoolRegistry_tq_shape_drift_error()_patch_mooncake_register_check()_assert_tq_stores_scalar_rows_0d()_patch_scalar_field_schema()_with_cached_cpu_count()_patch_physical_core_count()_patch_mooncake_staging_buffers()_MooncakeMasterArgv_METRICS_PORT_DRIFT_CONSEQUENCE_patch_mooncake_master_metrics_port()_connect_existing()_connect_existing_with_segment_size()_STORAGE_UNITS_SC_ONLY_pin_simple_storage_units()_init_tq()_assert_no_key_loss()_from_wire()TQDataPlaneClient_gdr_requested_gdr_put_confirmed__getstate__()__setstate__()_read_complete_checkpoint_metadata()_require_checkpointing_support()_mark_data_operation_started()_require_clean_for_load()register_partition()claim_meta()get_data()check_consumption_status()put_samples()get_samples()list_sample_ids()clear_samples()save_checkpoint()load_checkpoint()close()
- Module Contents
nemo_rl.data_plane.adapters.tq_mooncake_checkpoint- Module Contents
- Classes
- Functions
- Data
- API
_STORAGE_DIR_MANIFEST_FILE_DEFAULT_TIMEOUT_S_BATCH_KEYS_BATCH_BYTES_BUFFER_ALIGNMENT_QUARANTINED_BUFFERS_fsync_directory()_checkpoint_settings()_checkpoint_enabled()_storage_layout()_validate_metadata_mode()_validate_checkpoint_runtime()_replicas_are_pinned()_has_no_named_dims()_physical_keys()_StoredObject_SaveGroup_ParticipantInfo_ParticipantRequest_ManifestObject_ShardIndex_controller_path()_controller_keys()_CheckpointBuffer_unregister_or_quarantine()_registered_buffer()_write_buffer()_read_buffer()_checkpoint_batches()_checkpoint_buffer()_check_batch_results()_batch_replicas()_status_is_complete()_complete_memory_replicas()_has_complete_local_disk_replica()_complete_memory_buffers()_controller_session()_request_body()_safe_shard_name()_manifest_object_from_mapping()_shard_index_from_mapping()_parse_shard_indexes()_read_shard_indexes()_write_shard_index()_local_replica_config()_CheckpointParticipant_fanout_requests()_require_exact_responses()_live_participants()_write_manifest()_save_storage_checkpoint()_load_manifest()_require_clean_store()_load_sharded_checkpoint()_load_storage_checkpoint()_CheckpointManagerMixinconfigure_checkpoint_workers()run_checkpoint_command()install_tq_mooncake_checkpoint_plugin()__all__
- Module Contents
nemo_rl.data_plane.adapters.transfer_queue_env
- Submodules
- Submodules
nemo_rl.data_plane.worker_mixin- Module Contents
- Classes
- Functions
- Data
- API
FetchPolicy_ROUTE_BLOB_ROUTE_INDEX_pack_route_fragments()_unpack_route_fragments()_broadcast_batched_data_dict()_materialize_fetched()TQWorkerMixin_dp_client_route_fallback_countssetup_data_plane()mooncake_checkpoint()_require_dp_client()_get_replica_group()_routed_experts_dimensions()_pad_value_dict()_forward_pad_seqlen()get_data_plane_snapshot()_fetch()_fetch_route_fragments()_route_fragments_by_row()_maybe_assemble_routed_experts()_route_plans()_assemble_routed_experts()_apply_packing_prep()_attach_or_repack_pack_metadata()_local_coords()_is_replica_leader()_is_stage_local_writer()_write_back_stage_local()_write_back()_write_back_result_field()train_presharded()get_logprobs_presharded()get_reference_policy_logprobs_presharded()get_teacher_logprobs_presharded()get_values_presharded()begin_train_step_presharded()train_microbatch_presharded()finish_train_step_presharded()abort_train_step_presharded()
- Module Contents
nemo_rl.data_plane.codecnemo_rl.data_plane.groupingnemo_rl.data_plane.factorynemo_rl.data_plane.driver_mixinnemo_rl.data_plane.column_ionemo_rl.data_plane.schema- Module Contents
- Functions
- Data
- API
LayoutMICRO_BATCH_INDICESMICRO_BATCH_LENGTHSELEM_COUNTS_PER_GBGLOBAL_FORWARD_PAD_SEQLENROLLOUT_METRICSGROUP_ID_TAGPER_TOKEN_STAGING_FIELDSINPUT_IDSINPUT_LENGTHSSAMPLE_MASKMASK_SAMPLETRUNCATEDMETA_IDXINVALID_TOOL_CALL_MASKMALFORMED_THINKING_MASKDP_TRAIN_FIELDSOPD_FULL_HIDDEN_STATES_FIELDOPD_FULL_LOGITS_FIELDOPD_FULL_FIELDSOPD_FULL_TEACHER_INDEX_FIELDSC_ROLLOUT_SCHEMA_FIELDSLP_SEED_FIELDSTEACHER_LP_FIELDSPPO_VALUE_FIELDSDP_VALUE_TRAIN_FIELDSVALUE_SEED_FIELDSDP_CALIB_INPUT_FIELDSROUTED_EXPERTS_FIELDMICROBATCH_PADDED_FIELDSROUTED_LEN_FIELDROUTED_EXPERTS_ENCODING_FIELDROUTED_EXTRAS_METADATA_FIELDROUTE_ENCODING_NONEROUTE_ENCODING_ENVELOPEROUTE_ENCODING_LISTROUTE_PLAN_TAGROUTE_PASSTHROUGH_FLAGfields_with_optional_routed_experts()fields_with_optional_opd_full()
- Module Contents
nemo_rl.data_plane.tq_token_sink- Module Contents
- Classes
- Functions
- Data
- API
MEDIA_PRESENT_FIELDMEDIA_HAS_FRAMES_FIELDMEDIA_IMGS_FIELDMEDIA_IMGS_SIZES_FIELDMEDIA_NUM_FRAMES_FIELDMEDIA_METADATA_DIGEST_FIELDMEDIA_TENSOR_COLUMNSMEDIA_FLAG_FIELDSMEDIA_METADATA_FIELDSMEDIA_STAGING_FIELDS_MEDIA_REQUIRED_MEDIA_PIXEL_DTYPES_MEDIA_INDEX_DTYPESSTAGING_FIELDS_MODE_TO_CODE_CODE_TO_MODEMediaMetadataIntegrityError_bytes_tensor()_optional_digest_fields()StagedMediaTensorsMediaItemSizesmedia_item_sizes()_media_sentinels()validate_media_tensors()_check_int32_positive()FetchedStagedCall_call_dp()TQStagingStoreTQTokenSinkStagedPrefixChainPrefixCacheresolve_admission_prefix()resolve_admission_prefix_chains()_media_columns()TQTokenSource_select_row()_row_leaf()_row_text()_row_to_base_snapshot()_row_extras()_row_to_route_fragment()_row_scalar_int()_row_scalar_bool()_row_media_item_sizes()
- Module Contents
nemo_rl.data_plane.async_utilsnemo_rl.data_plane.mooncake_storage_unitnemo_rl.data_plane.observability- Module Contents
- Classes
- Functions
- Data
- API
EventStatusDataPlaneEventlogger_OP_ATTR_PARTITION_ATTR_KEYS_ATTR_BYTES_ATTR_STATUS_ATTRLATENCY_BUCKETS_MS_WRITE_OPS_READ_OPS_comm_volume()_MAX_HASH_MISMATCH_LOGS_HASH_SUFFIX_hash_field()_with_mirrors()_RECONCILE_ROWS_HASH_FIELDS_QUANTILES_INT_VIEW_BY_WIDTH_leaf_digests()_field_digests()_as_list()_tensor_bytes()_percentile_from_hist()_estimate_encoded_bytes()_NONTENSOR_STACK_SAMPLES_nontensor_stack_bytes()_td_bytes()_step_deltas()_op_step_stats()_hash_deltas()_volume_mb()_BY_OP_BY_OP_NAMESPACES_op_series()_percent_of_dataplane()_clamped_percentiles()_derive_op_metrics()_SNAPSHOT_SUM_SNAPSHOT_MAX_OP_SUM_OP_MAXmerge_snapshots()cluster_step_metrics()_step_metrics()_HEADLINE_HEADLINE_PREFIXESheadline_series()_BREAKDOWN_COLUMNSbreakdown_table()_panel_failuresmetrics_never_fail_the_step()log_step_metrics()log_event()_annotate()OpStatsHashStatsDataPlaneStatsMetricsDataPlaneClientobservability_enabledsnapshot()get_step_metrics()_record_put()_record_clear()_release_cleared_samples()_bill_self()_row_fingerprints()_hash_guard_failed()_stamp_hashes()_stamp_hashes_impl()_check_hashes()_check_hashes_impl()_run()_emit()register_partition()claim_meta()get_data()check_consumption_status()put_samples()get_samples()list_sample_ids()clear_samples()save_checkpoint()load_checkpoint()close()
is_metrics_client()
- Module Contents
nemo_rl.data_plane.preshardnemo_rl.data_plane.interfaces- Module Contents
- Classes
- Functions
- Data
- API
DATA_PLANE_CHECKPOINT_SCHEMA_VERSIONSsdOffloadConfigSimpleStorageConfigMooncakeSsdOffloadConfigMooncakeCpuConfigDataPlaneConfig_CHECKPOINTABLE_BACKENDSdata_plane_supports_checkpointing()_BACKEND_MODELSbackend_config()storage_unit_placement()ObservabilityConfigLocalDataPlaneConfigDataPlaneRuntimeConfigKVBatchMetaDataPlaneClient
- Module Contents
- Package Contents
- Subpackages
nemo_rl.telemetry- Submodules
nemo_rl.telemetry.instrumentation- Module Contents
- Classes
- Functions
- Data
- API
RL_ALGORITHMloggerRL_BUCKET_ATTRRL_EFFICIENCY_CATEGORY_ATTRRL_ITERATION_ATTRRL_IDLE_POLLS_ATTR__all__safe_set_span_attributes()BucketUMBRELLA_GROUPS_DEFAULT_GROUP_BUCKETEFFICIENCY_CATEGORY_BUCKETbucket_for_span_group()bucket_for_efficiency_category()COLLECTOR_LOOP_CATEGORIESUNBUCKETED_SPAN_CATEGORIES_BUCKET_OVERRIDEbucket_scope()iteration_scope()_PER_PROMPT_SCOPEper_prompt_scope()in_per_prompt_scope()goodput_span_attributes()current_trace_carrier()remote_trace_context()remote_trace_parent()attached_context()TRACE_CARRIER_KWARG_Ftrace_context_kwargs()_CARRIER_REFUSEDdispatch_with_trace_context()_dispatch_method_name()_advertise_carrier()accepts_trace_context()managed_span()_LEAF_GROUP_AT_UMBRELLA_CALL_warn_leaf_group_at_umbrella_call()umbrella_span()streaming_umbrella_span()NO_SPAN_no_span_activation()_efficiency_span_name_and_attrs()efficiency_span()start_efficiency_span()startup_span()setup_span()evaluate_span()checkpoint_finalize_span()trace_fn()umbrella_trace_fn()
- Module Contents
nemo_rl.telemetry.host_memory- Module Contents
- Classes
- Functions
- Data
- API
loggerRL_HOST_MEMORY_USED_METRICRL_HOST_MEMORY_TOTAL_METRICHOST_NAME_ATTRRL_WORKER_GROUPS_ATTRNO_WORKER_GROUPSRAY_NODE_MEM_USEDRAY_NODE_MEM_TOTAL_SERIES_BY_RAY_NAME_USED_KEY_TOTAL_KEY_SNAPSHOT_SNAPSHOT_LOCK_observations()_observe_used()_observe_total()HOST_MEMORY_RECORDED_METRICSFALLBACK_COLLECTION_INTERVAL_SCRAPE_TIMEOUT_S_SHUTDOWN_GRACE_S_WORKER_GROUP_NODES_WORKER_GROUP_LOCKregister_worker_group_nodes()register_worker_group_placement()forget_worker_group_nodes()worker_group_names_on_node()format_worker_groups()worker_groups_on_node()RayNoderay_nodes()parse_memory_samples()HostMemoryMonitor_MONITORstart_host_memory_monitoring()stop_host_memory_monitoring()
- Module Contents
nemo_rl.telemetry.confignemo_rl.telemetry.span_groupsnemo_rl.telemetry.vocabulary- Module Contents
- Classes
- Functions
- Data
- API
METRIC_NAME_PREFIXINIT_TOTAL_CATEGORYWORKER_GROUP_ENVEFFICIENCY_PCT_KEYEFFICIENCY_PCT_PER_STEP_KEYRUN_WINDOW_WALL_CLOCK_CATEGORIESas_scalar()registry_key()RecordedMetricTeedMetric_REGISTERED_FROZENfreeze_metrics()_check_not_frozen()register_teed_metrics()teed_metrics()_RECORDEDregister_recorded_metrics()recorded_metrics()
- Module Contents
nemo_rl.telemetry.setup- Module Contents
- Functions
- Data
- API
logger_F_TELEMETRY_HANDLE_TELEMETRY_INITIALISED_OTEL_PREFIX_OTEL_FALLBACK_PREFIX_RUN_ID_ENV_PROVIDER_NAME_CAMPAIGN_STAGE_ATTR_DEFAULT_CAMPAIGN_STAGE_CAMPAIGN_STAGE_BY_ALGORITHM_CAMPAIGN_STAGE_ENV_campaign_stage()_ENV_FIELD_MAP_SERVICE_NAME_ENV_is_env_truthy()telemetry_enabled_in_env()vllm_native_tracing_requested()_config_to_env()_dig()_build_resource_attributes()_megatron_enabled()_topology_attributes()_training_config_attributes()_software_versions()_process_attributes()init_telemetry_driver()_WORKER_GROUP_ATTR_worker_resource_attributes()init_telemetry_worker()_AIOHTTP_INSTRUMENTEDinstrument_aiohttp_client()traced_worker_init()get_telemetry_handle()shutdown_telemetry()
- Module Contents
nemo_rl.telemetry.metrics- Module Contents
- Functions
- Data
- API
logger_TRAIN_PREFIXESRL_EFFICIENCY_SECONDS_METRICRL_EFFICIENCY_PCT_METRICRL_EFFICIENCY_MEASUREMENT_ATTRWALL_CLOCK_MEASUREMENTCOLLECTOR_WALL_CLOCK_MEASUREMENTTHREAD_SECONDS_MEASUREMENTRL_EFFICIENCY_WINDOW_ATTRSTEP_WINDOWRUN_WINDOWRL_SETUP_DURATION_METRICRL_SETUP_PHASE_ATTR_EFFICIENCY_KEY_PREFIX_EFFICIENCY_SECONDS_SUFFIXRL_METRIC_GROUP_EFFICIENCY_SECONDS_KEY_EFFICIENCY_PCT_KEY_REGISTRY_SETUP_DURATION_KEY_REGISTERED_REGISTRATION_FAILED_WARNEDwarn_once()_metric_specs()ensure_metric_group_registered()_record()record_rl_metrics()create_rl_metric_instruments()efficiency_measurements()efficiency_window()map_efficiency_seconds()setup_phasemap_setup_seconds_tee_setup_metrics()map_teed_scalars()_tee_scalars()_tee_efficiency_metrics()tee_rl_metrics_to_otel()_tee_rl_metrics_to_otel()
- Module Contents
- Package Contents
- Submodules
- Submodules
- Package Contents
- Subpackages