Reference

This section collects the compact API and command references. Start with the YAML and dataset pages when editing configuration files; use the API, CLI, and export references when integrating NF2 into scripts or pipelines.

Configuration References

• Full YAML reference is grouped by general run keys, data, model, training, losses, callbacks, and transforms.

• Dataset and sampler reference lists configurable keys for boundary, sampler, and validation dataset types.

Interfaces

• API reference documents the public Python interface.

• CLI reference documents the installed command-line tools.

• Export and metrics reference lists export metrics and quality metrics.

Reference

• Full YAML Reference
  • General Run Keys
  • Data And Geometry
  • Model
  • Training
  • Losses And Scaling
  • Callbacks And Transforms
• Dataset And Sampler Reference
  • Dataset Types
  • analytical
  • sharp
  • fits
  • los_trv_azi
  • los
  • fld_inc_azi
  • height
  • potential
  • cube
  • slices
  • map
  • random_radial_grouped
  • sphere
  • spherical_slices
• API Reference
  • download_hmi_full_disk()
  • download_hmi_sharp()
  • download_hmi_synoptic()
  • download_sharp_series()
  • export_file()
  • export_series()
  • load()
  • run()
  • run_series()
  • CartesianOutput
  • SphericalOutput
  • export_file()
  • export_series()
  • compute_metrics()
  • print_metrics()
  • download_hmi_sharp()
  • download_hmi_synoptic()
  • download_hmi_full_disk()
• CLI Reference
  • nf2-extrapolate
  • nf2-extrapolate-series
  • nf2-download
  • nf2-export
  • nf2-metrics
  • nf2-noaa-to-sharp
• Export And Metrics Reference
  • Export Metrics
  • Quality Metrics