torchebm 0.2.4__py3-none-any.whl

docs/api/index.md

@@ -0,0 +1,111 @@
+---
+title: API Reference
+description: Detailed API reference for TorchEBM
+icon: material/api
+---
+
+# TorchEBM API Reference
+
+Welcome to the TorchEBM API reference documentation. This section provides detailed information about the classes and functions available in TorchEBM.
+
+## Package Structure
+
+TorchEBM is organized into several modules:
+
+<div class="grid cards" markdown>
+
+-   :material-cube-outline:{ .lg .middle } __Core__
+
+    ---
+
+    Base classes and core functionality for energy functions, samplers, and trainers.
+
+    [:octicons-arrow-right-24: Core Module](./torchebm/core)
+
+-   :material-dice-multiple-outline:{ .lg .middle } __Samplers__
+
+    ---
+
+    Sampling algorithms for energy-based models including Langevin Dynamics and MCMC.
+
+    [:octicons-arrow-right-24: Samplers](./torchebm/samplers)
+
+-   :material-function-variant:{ .lg .middle } __Losses__
+
+    ---
+
+    Loss functions for training energy-based models.
+
+    [:octicons-arrow-right-24: Losses](./torchebm/losses)
+
+-   :material-tools:{ .lg .middle } __Utils__
+
+    ---
+
+    Utility functions for working with energy-based models.
+
+    [:octicons-arrow-right-24: Utils](./torchebm/utils)
+    
+-   :material-gpu:{ .lg .middle } __CUDA__
+
+    ---
+
+    CUDA-accelerated implementations for faster computation.
+
+    [:octicons-arrow-right-24: CUDA](./torchebm/cuda)
+
+</div>
+
+## Getting Started with the API
+
+If you're new to TorchEBM, we recommend starting with the following classes:
+
+- [`EnergyFunction`](./torchebm/core/energy_function/classes/EnergyFunction): Base class for all energy functions
+- [`BaseSampler`](./torchebm/core/basesampler/classes/BaseSampler): Base class for all sampling algorithms
+- [`LangevinDynamics`](./torchebm/samplers/langevin_dynamics/classes/LangevinDynamics): Implementation of Langevin dynamics sampling
+
+## Core Components
+
+### Energy Functions
+
+TorchEBM provides various built-in energy functions:
+
+| Energy Function | Description |
+| --------------- | ----------- |
+| [`GaussianEnergy`](./torchebm/core/energy_function/classes/GaussianEnergy.md) | Multivariate Gaussian energy function |
+| [`DoubleWellEnergy`](./torchebm/core/energy_function/classes/DoubleWellEnergy.md) | Double well potential energy function |
+| [`RastriginEnergy`](./torchebm/core/energy_function/classes/RastriginEnergy.md) | Rastrigin function for testing optimization algorithms |
+| [`RosenbrockEnergy`](./torchebm/core/energy_function/classes/RosenbrockEnergy.md) | Rosenbrock function (banana function) |
+| [`AckleyEnergy`](./torchebm/core/energy_function/classes/AckleyEnergy.md) | Ackley function, a multimodal test function |
+| [`HarmonicEnergy`](./torchebm/core/energy_function/classes/HarmonicEnergy.md) | Harmonic oscillator energy function |
+
+### Samplers
+
+Available sampling algorithms:
+
+| Sampler | Description |
+| ------- | ----------- |
+| [`LangevinDynamics`](./torchebm/samplers/langevin_dynamics/classes/LangevinDynamics.md) | Langevin dynamics sampling algorithm |
+| [`HamiltonianMonteCarlo`](./torchebm/samplers/mcmc/classes/HamiltonianMonteCarlo.md) | Hamiltonian Monte Carlo sampling |
+
+### Loss Functions
+
+TorchEBM implements several loss functions for training EBMs:
+
+| Loss Function | Description |
+| ------------- | ----------- |
+| [`ContrastiveDivergence`](./torchebm/losses/contrastive_divergence/classes/ContrastiveDivergence.md) | Standard contrastive divergence (CD-k) |
+| [`PersistentContrastiveDivergence`](./torchebm/losses/contrastive_divergence/classes/PersistentContrastiveDivergence.md) | Persistent contrastive divergence |
+| [`ParallelTemperingCD`](./torchebm/losses/contrastive_divergence/classes/ParallelTemperingCD.md) | Parallel tempering contrastive divergence |
+
+## Module Details
+
+For detailed information about each module, follow the links below:
+
+- [Core Module](./torchebm/core)
+- [Samplers](./torchebm/samplers)
+- [Losses](./torchebm/losses)
+- [Models](./torchebm/models)
+- [Utils](./torchebm/utils)
+- [CUDA](./torchebm/cuda)
+

docs/api/torchebm/core/basesampler/classes/BaseSampler.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.basesampler.BaseSampler
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/basesampler/index.md

@@ -0,0 +1,31 @@
+# Torchebm > Core > Basesampler
+
+## Contents
+
+### Classes
+
+- [`BaseSampler`](classes/BaseSampler) - Base class for samplers.
+
+## API Reference
+
+::: torchebm.core.basesampler
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/energy_function/classes/AckleyEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.AckleyEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/DoubleWellEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.DoubleWellEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/EnergyFunction.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.EnergyFunction
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/GaussianEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.GaussianEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/HarmonicEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.HarmonicEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/RastriginEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.RastriginEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/classes/RosenbrockEnergy.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.energy_function.RosenbrockEnergy
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/energy_function/index.md

@@ -0,0 +1,37 @@
+# Torchebm > Core > Energy_function
+
+## Contents
+
+### Classes
+
+- [`AckleyEnergy`](classes/AckleyEnergy) - Energy function for the Ackley function.
+- [`DoubleWellEnergy`](classes/DoubleWellEnergy) - Energy function for a double well potential. E(x) = h * Σ((x²-1)²) where h is the barrier height.
+- [`EnergyFunction`](classes/EnergyFunction) - Abstract base class for energy functions (Potential Energy E(x)).
+- [`GaussianEnergy`](classes/GaussianEnergy) - Energy function for a Gaussian distribution. E(x) = 0.5 * (x-μ)ᵀ Σ⁻¹ (x-μ).
+- [`HarmonicEnergy`](classes/HarmonicEnergy) - Energy function for a harmonic oscillator. E(x) = 0.5 * k * Σ(x²).
+- [`RastriginEnergy`](classes/RastriginEnergy) - Energy function for the Rastrigin function.
+- [`RosenbrockEnergy`](classes/RosenbrockEnergy) - Energy function for the Rosenbrock function. E(x) = (a-x₁)² + b·(x₂-x₁²)².
+
+## API Reference
+
+::: torchebm.core.energy_function
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/index.md

@@ -0,0 +1,36 @@
+# Torchebm > Core
+
+## Contents
+
+### Modules
+
+- [Basesampler](basesampler.md)
+- [Energy_function](energy_function.md)
+- [Losses](losses.md)
+- [Optimizer](optimizer.md)
+- [Score_matching](score_matching.md)
+- [Trainer](trainer.md)
+
+## API Reference
+
+::: torchebm.core
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/losses/classes/Loss.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.losses.Loss
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/losses/index.md

@@ -0,0 +1,31 @@
+# Torchebm > Core > Losses
+
+## Contents
+
+### Classes
+
+- [`Loss`](classes/Loss) - No description available.
+
+## API Reference
+
+::: torchebm.core.losses
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/optimizer/classes/Optimizer.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.optimizer.Optimizer
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/optimizer/index.md

@@ -0,0 +1,31 @@
+# Torchebm > Core > Optimizer
+
+## Contents
+
+### Classes
+
+- [`Optimizer`](classes/Optimizer) - No description available.
+
+## API Reference
+
+::: torchebm.core.optimizer
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/score_matching/classes/ScoreMatching.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.score_matching.ScoreMatching
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/score_matching/index.md

@@ -0,0 +1,31 @@
+# Torchebm > Core > Score_matching
+
+## Contents
+
+### Classes
+
+- [`ScoreMatching`](classes/ScoreMatching) - No description available.
+
+## API Reference
+
+::: torchebm.core.score_matching
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/core/trainer/classes/ContrastiveDivergenceTrainer.md

@@ -0,0 +1,23 @@
+## Methods and Attributes
+
+::: torchebm.core.trainer.ContrastiveDivergenceTrainer
+    options:
+      show_root_heading: false
+      show_source: true
+      members_order: source
+      show_category_heading: false
+      show_if_no_docstring: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      docstring_section_style: table
+      trim_doctest_flags: true
+      inherited_members: false
+      filters:
+        - "!^_[^_]"
+        - "!^__"

docs/api/torchebm/core/trainer/index.md

@@ -0,0 +1,31 @@
+# Torchebm > Core > Trainer
+
+## Contents
+
+### Classes
+
+- [`ContrastiveDivergenceTrainer`](classes/ContrastiveDivergenceTrainer) - No description available.
+
+## API Reference
+
+::: torchebm.core.trainer
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"

docs/api/torchebm/cuda/index.md

@@ -0,0 +1,27 @@
+# Torchebm > Cuda
+
+## Contents
+
+## API Reference
+
+::: torchebm.cuda
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+      show_source: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true
+      show_docstring_attributes: false
+      show_docstring_classes: true
+      show_docstring_functions: true
+      trim_doctest_flags: true
+      show_category_heading: false
+      show_if_no_docstring: true
+      members_order: source
+      show_signature_annotations: true
+      separate_signature: true
+      unwrap_annotated: true
+      docstring_section_style: table
+      inherited_members: false
+      members:
+        - "!__*"