Skip to main content

Simple Gradient Noise Scale (GNS) calculation for PyTorch

Project description

GNS PyTorch

This is the easiest way to calculate GNS (Gradient Noise Scale) for your PyTorch models. No hooks, gradient accumulation, or multi-GPU setup needed. Just pass in your per-example losses and model.

What's GNS?

GNS measures gradient noise in your training. See https://arxiv.org/pdf/1812.06162 and https://openreview.net/forum?id=xINTMAvPQA

Install

pip install gns-pytorch

Usage

Simple usage:

from gns_pytorch import compute_gns
import torch

model = YourModel()
optimizer = torch.optim.Adam(model.parameters())

def training_step(batch):
    x, y = batch
    logits = model(x)
    per_example_losses = torch.nn.functional.cross_entropy(logits, y, reduction='none')
    
    if global_step % 100 == 0:
        gns_value = compute_gns(per_example_losses, model)
        gns_ema = 0.9 * gns_ema + 0.1 * gns_value
        print(f"Current GNS (EMA): {gns_ema}")
    
    loss = per_example_losses.mean()
    optimizer.zero_grad()
    loss.backward()
    optimizer.step()

Adaptive Batch Size Scheduling

With accurate GNS you can schedule your batch size (using gradient accumulation) to always be critical / optimal throughout training, massively boosting convergence and sample efficiency. This is similar to what deepseek-v3 did.

Tips

  • Call compute_gns every N steps (like 100+) to avoid overhead
  • Use an EMA on the GNS values since they are very noisy
  • The param_percentage param lets you sample a subset of model parameters for faster computation
  • Enable vmap with use_vmap=True to speed up computation by parallelizing per-example gradients (unfortunately, PyTorch's vmap isn't composable with flex attention and torch.compile yet)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gns_pytorch-0.1.1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gns_pytorch-0.1.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file gns_pytorch-0.1.1.tar.gz.

File metadata

  • Download URL: gns_pytorch-0.1.1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for gns_pytorch-0.1.1.tar.gz
Algorithm Hash digest
SHA256 59ab876e9b109803c707e16f3df581e642bf46eefe8542ebd98dea5f8a5ce1f3
MD5 77b3adff8f392d9436b2fd3578237a88
BLAKE2b-256 56b497afcb46504f500953eb691ff7c13228c6461104ce35b353c9f7e8303c71

See more details on using hashes here.

File details

Details for the file gns_pytorch-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gns_pytorch-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a78796a0cebd0bf3a55ca6d22010cecc8983695e7126434adbe7f3d2b5350fe9
MD5 cb0f3a05cc5eec89e2179537ee8a956b
BLAKE2b-256 7ff2669ff9f213d21681142e46ffa6831c6a793799031471ccc17e3153a10780

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page