Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
NLSQ Documentation
NLSQ Documentation

Guides

  • Routine User Guide
    • Routine User Tutorials
      • 1. Getting Started
        • 1.1. Installation
        • 1.2. Your First Curve Fit
        • 1.3. Understanding Results
      • 2. The 3-Workflow System
        • 2.1. workflow=”auto” - Local Optimization
        • 2.2. workflow=”auto_global” - Global Optimization
        • 2.3. workflow=”hpc” - HPC Cluster Optimization
      • 3. Model Selection
        • 3.1. Built-in Models
        • 3.2. Custom Models
        • 3.3. Model Validation
      • 4. Data Handling
        • 4.1. Basic Data
        • 4.2. Uncertainties (Sigma)
        • 4.3. Parameter Bounds
        • 4.4. Large Datasets
      • 5. GPU Acceleration
        • 5.1. GPU Setup
        • 5.2. GPU Usage
        • 5.3. Multi-GPU
      • 6. Desktop GUI Application
        • 6.1. Launching the GUI
        • 6.2. Workflow Pages
        • 6.3. Fitting Presets
      • 7. Troubleshooting
        • 7.1. Common Issues
        • 7.2. Getting Help
    • 2. The 3-Workflow System
      • 2.1. workflow=”auto” - Local Optimization
      • 2.2. workflow=”auto_global” - Global Optimization
      • 2.3. workflow=”hpc” - HPC Cluster Optimization
    • 1. Getting Started
      • 1.1. Installation
      • 1.2. Your First Curve Fit
      • 1.3. Understanding Results
    • Migration Guide
    • How to Choose a Model Function
    • Workflow System Overview
    • Common Workflows
    • Configuration Reference
    • CLI Reference
    • GUI User Guide
      • 6. Desktop GUI Application
        • 6.1. Launching the GUI
        • 6.2. Workflow Pages
        • 6.3. Fitting Presets
    • 6. Desktop GUI Application
      • 6.1. Launching the GUI
      • 6.2. Workflow Pages
      • 6.3. Fitting Presets
  • Advanced User Guide
    • Advanced User Tutorials
      • 1. Architecture Overview
        • 1.1. Package Overview
        • 1.2. Optimization Pipeline
        • 1.3. JAX Patterns
      • 2. Core APIs
        • 2.1. CurveFit Class
        • 2.2. LeastSquares Class
        • 2.3. TRF Optimizer
        • 2.4. Result Types
      • 3. Factories and Dependency Injection
        • 3.1. Factory Functions
        • 3.2. Protocols
        • 3.3. Adapters
        • 3.4. Dependency Injection
      • 4. Orchestration Components (v0.6.4)
        • 4.1. Orchestration Overview
        • 4.2. DataPreprocessor
        • 4.3. OptimizationSelector
        • 4.4. CovarianceComputer
        • 4.5. StreamingCoordinator
        • 4.6. Facades
      • 5. Custom Workflows
      • 6. Performance Optimization
      • 7. Numerical Stability
      • 8. Extending NLSQ
    • 1. Architecture Overview
      • 1.1. Package Overview
      • 1.2. Optimization Pipeline
      • 1.3. JAX Patterns
    • 2. Core APIs
      • 2.1. CurveFit Class
      • 2.2. LeastSquares Class
      • 2.3. TRF Optimizer
      • 2.4. Result Types
    • 4. Orchestration Components (v0.6.4)
      • 4.1. Orchestration Overview
      • 4.2. DataPreprocessor
      • 4.3. OptimizationSelector
      • 4.4. CovarianceComputer
      • 4.5. StreamingCoordinator
      • 4.6. Facades
    • Core API Reference
    • Orchestration Components
    • Facades
    • Advanced Customization Guide
    • 3. Factories and Dependency Injection
      • 3.1. Factory Functions
      • 3.2. Protocols
      • 3.3. Adapters
      • 3.4. Dependency Injection
    • 6. Performance Optimization
    • Large Dataset Tutorial
    • Performance Optimization Guide
    • How to Use Streaming Checkpoints
    • Large Dataset API Reference
    • 7. Numerical Stability
    • 8. Extending NLSQ
    • How to Debug Bad Fits
    • Troubleshooting Guide
    • Concepts & Explanations
      • How Curve Fitting Works
      • Trust Region Reflective Algorithm
      • JAX and Automatic Differentiation
      • Numerical Stability Guide
      • Group Variance Regularization
      • Adaptive Hybrid Streaming Optimizer
      • GPU Architecture and Acceleration
      • Workflow System Overview

Project Info

  • Reference
    • Core API Reference
    • Model Functions Reference
    • Large Dataset API Reference
    • Global Optimization
    • Orchestration Components
    • Facades
    • Configuration Reference
    • Visualization API
    • CLI Reference
  • Developer Documentation
    • Architecture Overview
    • NLSQ Optimization Case Study: When to Stop Optimizing
    • NLSQ Performance Tuning Guide
    • Documentation Quality Assurance
    • PyPI Publishing Setup Guide
    • Notebook Configuration Utilities
    • CI/CD Documentation
      • GitHub Actions - Developer Guide
    • Architecture Decision Records (ADRs)
  • Documentation Changelog
Back to top
View this page

nlsq.device.get_recommended_package¶

nlsq.device.get_recommended_package()[source]¶

Get recommended JAX package based on system CUDA.

Returns:

Package name like “jax[cuda12-local]” or “jax[cuda13-local]”, or None if no compatible setup found.

Return type:

str | None

Copyright © 2024-2025, Wei Chen (Argonne National Laboratory) | 2022, Original JAXFit Authors
Made with Sphinx and @pradyunsg's Furo
Last updated on May 10, 2026
On this page
  • nlsq.device.get_recommended_package
    • get_recommended_package()