Spaces:
Runtime error
Runtime error
File size: 31,312 Bytes
0558aa4 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 |
# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Unit tests for OneLoggerNeMoCallback."""
import os
from types import SimpleNamespace
from unittest.mock import MagicMock, patch
import pytest
from lightning.pytorch.callbacks import Callback as PTLCallback
from lightning.pytorch.callbacks import ModelCheckpoint
from omegaconf import OmegaConf
from nemo.lightning.base_callback import BaseCallback
from nemo.lightning.one_logger_callback import (
OneLoggerNeMoCallback,
_get_base_callback_config,
_should_enable_for_current_rank,
get_nemo_v1_callback_config,
get_nemo_v2_callback_config,
get_one_logger_init_config,
)
class TestOneLoggerNeMoCallback:
"""Test suite for OneLoggerNeMoCallback."""
def test_inheritance(self):
"""Test that OneLoggerNeMoCallback properly inherits from both parent classes."""
with (
patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback') as mock_ptl_callback,
patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider') as mock_provider,
patch('nemo.lightning.one_logger_callback.get_one_logger_init_config') as mock_get_config,
patch('nemo.lightning.one_logger_callback.OneLoggerConfig') as mock_config_class,
patch('nemo.lightning.one_logger_callback.on_app_start') as mock_on_app_start,
):
# Setup mocks
mock_get_config.return_value = {"application_name": "test", "session_tag_or_fn": "test-session"}
mock_config_instance = MagicMock()
mock_config_class.return_value = mock_config_instance
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback_instance = MagicMock()
mock_ptl_callback.return_value = mock_ptl_callback_instance
# Create callback instance
callback = OneLoggerNeMoCallback()
# Test inheritance
assert isinstance(callback, BaseCallback)
assert isinstance(callback, PTLCallback)
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback.__init__', return_value=None)
def test_init_configures_provider(
self, mock_ptl_callback_init, mock_on_app_start, mock_config_class, mock_get_config, mock_provider
):
"""Test that __init__ properly configures the OneLogger provider."""
# Setup mocks
mock_init_config = {
"application_name": "nemo",
"session_tag_or_fn": "test-session",
"enable_for_current_rank": True,
"world_size_or_fn": 1,
}
mock_get_config.return_value = mock_init_config
mock_config_instance = MagicMock()
mock_config_class.return_value = mock_config_instance
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
# Create callback instance
OneLoggerNeMoCallback()
# Verify initialization sequence
mock_get_config.assert_called_once()
mock_config_class.assert_called_once_with(**mock_init_config)
mock_provider_instance.with_base_config.assert_called_once_with(mock_config_instance)
mock_provider_instance.with_base_config.return_value.with_export_config.assert_called_once()
mock_provider_instance.with_base_config.return_value.with_export_config.return_value.configure_provider.assert_called_once()
mock_ptl_callback_init.assert_called_once_with(mock_provider_instance, call_on_app_start=False)
mock_on_app_start.assert_called_once_with()
class TestOneLoggerCallback:
"""Test cases for one_logger_callback utility functions."""
@pytest.mark.unit
def test_get_one_logger_init_config(self):
"""Test get_one_logger_init_config returns correct minimal configuration."""
with patch.dict(os.environ, {"SLURM_JOB_NAME": "test_job", "WORLD_SIZE": "4"}):
config = get_one_logger_init_config()
assert isinstance(config, dict)
assert config["application_name"] == "nemo"
assert config["session_tag_or_fn"] == "test_job"
assert "enable_for_current_rank" in config
assert config["world_size_or_fn"] == 4
@pytest.mark.unit
def test_get_one_logger_init_config_no_slurm(self):
"""Test get_one_logger_init_config when SLURM_JOB_NAME is not set."""
with patch.dict(os.environ, {"WORLD_SIZE": "1"}, clear=True):
config = get_one_logger_init_config()
assert config["session_tag_or_fn"] == "nemo-run"
assert config["world_size_or_fn"] == 1
@pytest.mark.unit
def test_get_base_callback_config(self):
"""Test _get_base_callback_config with basic trainer setup."""
trainer = MagicMock()
trainer.max_steps = 1000
trainer.callbacks = []
trainer.val_check_interval = 1.0
trainer.strategy = None
trainer.log_every_n_steps = 10
with patch.dict(os.environ, {"SLURM_JOB_NAME": "test_job", "WORLD_SIZE": "4", "PERF_VERSION_TAG": "1.0.0"}):
config = _get_base_callback_config(trainer=trainer, global_batch_size=32, seq_length=512)
assert config["perf_tag_or_fn"] == "test_job_1.0.0_bf32_se512_ws4"
assert config["global_batch_size_or_fn"] == 32
assert config["micro_batch_size_or_fn"] == 8
assert config["seq_length_or_fn"] == 512
assert config["train_iterations_target_or_fn"] == 1000
assert config["train_samples_target_or_fn"] == 32000
assert config["log_every_n_train_iterations"] == 10
assert config["is_validation_iterations_enabled_or_fn"] is True
assert config["is_save_checkpoint_enabled_or_fn"] is False
assert config["save_checkpoint_strategy"] == "sync"
@pytest.mark.unit
def test_get_base_callback_config_with_checkpoint_callback(self):
"""Test _get_base_callback_config when checkpoint callback is present."""
trainer = MagicMock()
trainer.max_steps = 1000
trainer.val_check_interval = 0
# Real ModelCheckpoint callback to satisfy isinstance checks
checkpoint_callback = ModelCheckpoint(dirpath=".", save_top_k=-1)
trainer.callbacks = [checkpoint_callback]
with patch.dict(os.environ, {"SLURM_JOB_NAME": "test_job", "WORLD_SIZE": "2"}):
config = _get_base_callback_config(trainer=trainer, global_batch_size=16, seq_length=256)
assert config["is_save_checkpoint_enabled_or_fn"] is True
assert config["is_validation_iterations_enabled_or_fn"] is False
@pytest.mark.unit
def test_get_base_callback_config_async_save(self):
"""Test _get_base_callback_config with async save strategy."""
trainer = MagicMock()
trainer.max_steps = 1000
trainer.callbacks = []
trainer.val_check_interval = 0 # Set to 0 to avoid validation
# Mock strategy with async_save
strategy = MagicMock()
strategy.async_save = True
trainer.strategy = strategy
with patch.dict(os.environ, {"WORLD_SIZE": "1"}):
config = _get_base_callback_config(trainer=trainer, global_batch_size=8, seq_length=128)
assert config["save_checkpoint_strategy"] == "async"
@pytest.mark.unit
def test_get_base_callback_config_dict_strategy(self):
"""Test _get_base_callback_config with dict strategy."""
trainer = MagicMock()
trainer.max_steps = 1000
trainer.callbacks = []
trainer.val_check_interval = 0 # Set to 0 to avoid validation
trainer.strategy = {"async_save": True}
with patch.dict(os.environ, {"WORLD_SIZE": "1"}):
config = _get_base_callback_config(trainer=trainer, global_batch_size=8, seq_length=128)
assert config["save_checkpoint_strategy"] == "async"
@pytest.mark.unit
def test_get_nemo_v1_callback_config(self):
"""Test get_nemo_v1_callback_config with model configuration."""
trainer = MagicMock()
trainer.max_steps = 500
trainer.val_check_interval = 0 # Set to 0 to avoid validation
# Mock lightning module with config
pl_module = MagicMock()
pl_module.cfg = OmegaConf.create({"train_ds": {"batch_size": 8}, "encoder": {"d_model": 768}})
trainer.lightning_module = pl_module
with patch.dict(os.environ, {"WORLD_SIZE": "2"}):
config = get_nemo_v1_callback_config(trainer)
assert config["global_batch_size_or_fn"] == 16 # 8 * 2
assert config["seq_length_or_fn"] == 768
assert config["train_iterations_target_or_fn"] == 500
@pytest.mark.unit
def test_get_nemo_v1_callback_config_bucket_batch_size(self):
"""Test get_nemo_v1_callback_config with bucket batch sizes (ASR case)."""
trainer = MagicMock()
trainer.max_steps = 1000
trainer.val_check_interval = 0 # Set to 0 to avoid validation
# Mock lightning module with bucket batch sizes
pl_module = MagicMock()
pl_module.cfg = OmegaConf.create({"train_ds": {"bucket_batch_size": [4, 8, 12]}, "encoder": {"d_model": 512}})
trainer.lightning_module = pl_module
with patch.dict(os.environ, {"WORLD_SIZE": "1"}):
config = get_nemo_v1_callback_config(trainer)
# Average bucket batch size is (4+8+12)/3 = 8
assert config["global_batch_size_or_fn"] == 8
assert config["seq_length_or_fn"] == 512
@pytest.mark.unit
def test_get_nemo_v1_callback_config_fallback(self):
"""Test get_nemo_v1_callback_config with fallback values."""
trainer = MagicMock()
trainer.max_steps = 100
trainer.val_check_interval = 0 # Set to 0 to avoid validation
# Mock lightning module without required config
pl_module = MagicMock()
pl_module.cfg = OmegaConf.create({})
trainer.lightning_module = pl_module
config = get_nemo_v1_callback_config(trainer)
assert config["global_batch_size_or_fn"] == 1 # fallback
assert config["seq_length_or_fn"] == 1 # fallback
assert config["train_iterations_target_or_fn"] == 100
@pytest.mark.unit
def test_get_nemo_v2_callback_config(self):
"""Test get_nemo_v2_callback_config with data module."""
trainer = MagicMock()
trainer.max_steps = 200
trainer.val_check_interval = 0 # Set to 0 to avoid validation
# Mock data module
data = MagicMock()
data.global_batch_size = 64
data.seq_length = 1024
with patch.dict(os.environ, {"WORLD_SIZE": "4"}):
config = get_nemo_v2_callback_config(trainer=trainer, data=data)
assert config["global_batch_size_or_fn"] == 64
assert config["seq_length_or_fn"] == 1024
assert config["train_iterations_target_or_fn"] == 200
@pytest.mark.unit
def test_get_nemo_v2_callback_config_uses_micro_when_global_missing(self):
"""Test v2 config computes global_batch_size via micro_batch_size * WORLD_SIZE when global is missing."""
trainer = MagicMock()
trainer.max_steps = 100
trainer.val_check_interval = 0
# Data module without global_batch_size, but with micro_batch_size and seq_length
data = SimpleNamespace(micro_batch_size=8, seq_length=2048)
with patch.dict(os.environ, {"WORLD_SIZE": "4"}):
config = get_nemo_v2_callback_config(trainer=trainer, data=data)
assert config["global_batch_size_or_fn"] == 32 # 8 * 4
assert config["seq_length_or_fn"] == 2048
assert config["train_iterations_target_or_fn"] == 100
@pytest.mark.unit
def test_get_nemo_v2_callback_config_no_data(self):
"""Test get_nemo_v2_callback_config without data module."""
trainer = MagicMock()
trainer.max_steps = 300
trainer.val_check_interval = 0 # Set to 0 to avoid validation
config = get_nemo_v2_callback_config(trainer=trainer, data=None)
assert config["global_batch_size_or_fn"] == 1 # fallback
assert config["seq_length_or_fn"] == 1 # fallback
assert config["train_iterations_target_or_fn"] == 300
@pytest.mark.unit
def test_should_enable_for_current_rank_single_process(self):
"""Test _should_enable_for_current_rank if rank is not set."""
with patch.dict(os.environ, {}, clear=True):
result = _should_enable_for_current_rank()
assert result is False
@pytest.mark.unit
def test_should_enable_for_current_rank_distributed_rank0(self):
"""Test _should_enable_for_current_rank for rank 0 in distributed training."""
with patch.dict(os.environ, {"RANK": "0", "WORLD_SIZE": "4"}):
result = _should_enable_for_current_rank()
assert result is True
@pytest.mark.unit
def test_should_enable_for_current_rank_distributed_middle_rank(self):
"""Test _should_enable_for_current_rank for middle rank in distributed training."""
with patch.dict(os.environ, {"RANK": "1", "WORLD_SIZE": "4"}):
result = _should_enable_for_current_rank()
assert result is False
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v1_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_v1(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v1_config,
mock_provider,
):
"""Test update_config with nemo_version='v1'."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
mock_v1_config = {"job_name": "test-job", "world_size": 1, "global_batch_size": 32, "seq_length": 1024}
mock_get_v1_config.return_value = mock_v1_config
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback and trainer
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
# Call update_config
callback.update_config(nemo_version='v1', trainer=trainer)
# Verify v1 config was called
mock_get_v1_config.assert_called_once_with(trainer=trainer)
mock_telemetry_config_class.assert_called_once_with(**mock_v1_config)
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v2_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_v2(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v2_config,
mock_provider,
):
"""Test update_config with nemo_version='v2' and data module."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
mock_v2_config = {"job_name": "test-job-v2", "world_size": 2, "global_batch_size": 64, "seq_length": 2048}
mock_get_v2_config.return_value = mock_v2_config
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback, trainer, and data module
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
data_module = MagicMock()
# Call update_config with v2 and data
callback.update_config(nemo_version='v2', trainer=trainer, data=data_module)
# Verify v2 config was called with data
mock_get_v2_config.assert_called_once_with(trainer=trainer, data=data_module)
mock_telemetry_config_class.assert_called_once_with(**mock_v2_config)
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v1_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_unknown_version_defaults_to_v1(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v1_config,
mock_provider,
):
"""Test update_config with unknown version defaults to v1."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
mock_v1_config = {"job_name": "test-job"}
mock_get_v1_config.return_value = mock_v1_config
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback and trainer
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
# Call update_config with unknown version
callback.update_config(nemo_version='unknown', trainer=trainer)
# Verify v1 config was called (default fallback)
mock_get_v1_config.assert_called_once_with(trainer=trainer)
mock_telemetry_config_class.assert_called_once_with(**mock_v1_config)
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v2_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_v2_without_data(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v2_config,
mock_provider,
):
"""Test update_config with nemo_version='v2' but no data module provided."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
mock_v2_config = {"job_name": "test-job-v2"}
mock_get_v2_config.return_value = mock_v2_config
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback and trainer
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
# Call update_config with v2 but no data
callback.update_config(nemo_version='v2', trainer=trainer)
# Verify v2 config was called with None data
mock_get_v2_config.assert_called_once_with(trainer=trainer, data=None)
mock_telemetry_config_class.assert_called_once_with(**mock_v2_config)
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v2_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_v2_with_extra_kwargs(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v2_config,
mock_provider,
):
"""Test update_config with nemo_version='v2' and extra kwargs."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
mock_v2_config = {"job_name": "test-job-v2"}
mock_get_v2_config.return_value = mock_v2_config
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback and trainer
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
data_module = MagicMock()
# Call update_config with v2, data, and extra kwargs
callback.update_config(
nemo_version='v2', trainer=trainer, data=data_module, extra_param1='value1', extra_param2='value2'
)
# Verify v2 config was called with data (extra kwargs should be ignored)
mock_get_v2_config.assert_called_once_with(trainer=trainer, data=data_module)
mock_telemetry_config_class.assert_called_once_with(**mock_v2_config)
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
def test_export_all_symbols(self):
"""Test that __all__ contains the expected symbols."""
from nemo.lightning.one_logger_callback import __all__
assert 'OneLoggerNeMoCallback' in __all__
@patch.dict(os.environ, {'EXP_NAME': 'test-experiment', 'WORLD_SIZE': '4'})
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_init_with_environment_variables(
self, mock_ptl_callback, mock_on_app_start, mock_config_class, mock_get_config, mock_provider
):
"""Test initialization with environment variables set."""
# Setup mocks
mock_get_config.return_value = {
"application_name": "nemo",
"session_tag_or_fn": "test-experiment",
"world_size_or_fn": 4,
}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
# Create callback instance
OneLoggerNeMoCallback()
# Verify that get_one_logger_init_config was called
mock_get_config.assert_called_once()
# Verify that the config was created with the environment-based values
mock_config_class.assert_called_once()
call_args = mock_config_class.call_args[1]
assert call_args['session_tag_or_fn'] == 'test-experiment'
assert call_args['world_size_or_fn'] == 4
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_nemo_v1_callback_config')
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryConfig')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback')
def test_update_config_with_empty_config(
self,
mock_ptl_callback,
mock_on_app_start,
mock_config_class,
mock_get_config,
mock_telemetry_config_class,
mock_get_v1_config,
mock_provider,
):
"""Test update_config with empty configuration dictionary."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_class.return_value = MagicMock()
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
mock_ptl_callback.return_value = MagicMock()
# Return empty config
mock_get_v1_config.return_value = {}
mock_telemetry_config_instance = MagicMock()
mock_telemetry_config_class.return_value = mock_telemetry_config_instance
# Create callback and trainer
callback = OneLoggerNeMoCallback()
trainer = MagicMock()
# Call update_config
callback.update_config(nemo_version='v1', trainer=trainer)
# Verify empty config was passed to TrainingTelemetryConfig
mock_telemetry_config_class.assert_called_once_with(**{})
mock_provider_instance.set_training_telemetry_config.assert_called_once_with(mock_telemetry_config_instance)
def test_callback_instantiation_without_mocks_raises_import_error(self):
"""Test that callback instantiation without proper mocks raises appropriate errors."""
# This test verifies that the callback properly depends on external libraries
# and will raise import errors if they're not available
with patch(
'nemo.lightning.one_logger_callback.OneLoggerPTLCallback.__init__',
side_effect=Exception("with_base_config can be called only before configure_provider is called."),
):
with pytest.raises(
Exception, match="with_base_config can be called only before configure_provider is called."
):
OneLoggerNeMoCallback()
@patch('nemo.lightning.one_logger_callback.TrainingTelemetryProvider')
@patch('nemo.lightning.one_logger_callback.get_one_logger_init_config')
@patch('nemo.lightning.one_logger_callback.OneLoggerConfig')
@patch('nemo.lightning.one_logger_callback.on_app_start')
@patch('nemo.lightning.one_logger_callback.OneLoggerPTLCallback.__init__', return_value=None)
def test_init_provider_chain_calls(
self, mock_ptl_callback_init, mock_on_app_start, mock_config_class, mock_get_config, mock_provider
):
"""Test that the provider configuration chain is called in correct order."""
# Setup mocks
mock_get_config.return_value = {"application_name": "test"}
mock_config_instance = MagicMock()
mock_config_class.return_value = mock_config_instance
mock_provider_instance = MagicMock()
mock_provider_instance.config = MagicMock()
mock_provider_instance.config.telemetry_config = None
mock_provider.instance.return_value = mock_provider_instance
# Create callback instance
OneLoggerNeMoCallback()
# Verify the provider configuration chain
mock_provider_instance.with_base_config.assert_called_once_with(mock_config_instance)
chain_result = mock_provider_instance.with_base_config.return_value
chain_result.with_export_config.assert_called_once()
chain_result.with_export_config.return_value.configure_provider.assert_called_once()
# Verify PTL callback was initialized with provider instance and explicit on_app_start was called
mock_ptl_callback_init.assert_called_once_with(mock_provider_instance, call_on_app_start=False)
mock_on_app_start.assert_called_once_with()
|