Skip to content
CAREamics
Compat
Search
GitHub
Home
Installation
Features
Guides
API Reference
CAREamics
GitHub
Home
Installation
Installation
Install with uv
Install with mamba
Testing GPU support
Features
Guides
Guides
Using CAREamics
Using CAREamics
Configuration
Data preparation
Training
Logging
Predicting
Lightning API
Tutorials
Tutorials
Custom Data Formats
Implementing an Image Stack
Patch Filtering
CAREamics UI
CAREamics UI
FAQ
FAQ
Legacy (v0.1)
Legacy (v0.1)
CAREamist API (v0.1)
CAREamist API (v0.1)
Configuration
Configuration
Convenience functions
Save and load
Custom types
Configuration errors
Build the configuration
Algorithm requirements
Using CAREamics (v0.1)
Using CAREamics (v0.1)
CAREamist
Training
(Intermediate) Datasets
Prediction
Export to BMZ
FAQ
Lightning API (v0.1)
Lightning API (v0.1)
Dev resources (v0.1)
Dev resources (v0.1)
Contribute to CAREamics
Docstring conventions
Conda-forge package
API Reference
API Reference
Careamics
Careamist
Config
Config
Configuration
N2V Configuration
Algorithms
Algorithms
CARE Algorithm Config
HDN Algorithm Config
Microsplit Algorithm Config
N2N Algorithm Config
N2V Algorithm Config
PN2V Algorithm Config
UNet Algorithm Config
VAE Algorithm Config
N2V Manipulation
N2V Manipulation
N2V Manipulate Config
Architectures
Architectures
Architecture Config
LVAE Config
UNet Config
Augmentations
Augmentations
Transform Unions
XY Flip Config
XY Random Rotate90 Config
Data
Data
Data Config
Normalization Config
Patch Filter
Patch Filter
Mask Filter Config
Max Filter Config
Meanstd Filter Config
Patch Filter Config
Shannon Filter Config
Patching Strategies
Patching Strategies
Random Patching Config
Sequential Patching Config
Stratified Patching Config
Tiled Patching Config
Whole Patching Config
Factories
Factories
Algorithm Factory
CARE N2N Factory
Config Discriminators
Data Factory
N2V Factory
Training Factory
Lightning
Lightning
Optimizer Configs
Parameters Filter
Training Configuration
Losses
Losses
Loss Config
Noise Model
Noise Model
Likelihood Config
Noise Model Config
Serializers
Support
Support
Supported Activations
Supported Algorithms
Supported Architectures
Supported Data
Supported Filters
Supported Loggers
Supported Losses
Supported Normalization
Supported Optimizers
Supported Patching
Supported Pixel Manipulations
Supported Struct Axis
Supported Transforms
Utils
Utils
Configuration IO
Random
Validators
Validators
Axes Validators
Model Validators
Patch Validators
Dataset
Dataset
Dataset
Image Region Data
Augmentation
Augmentation
Compose
Transform
XY Flip
XY Random Rotate90
Factory
Factory
Factory
Filter Bg
Val Split
Image Stack
Image Stack
Czi Image Stack
File Image Stack
Image Stack Protocol
In Memory Image Stack
Zarr Image Stack
Image Utils
Image Utils
Image Stack Utils
Image Stack Loader
Image Stack Loader
Image Stack Loader Protocol
Image Stack Loaders
Zarr Utils
Normalization
Normalization
Mean Std Normalization
No Normalization
Normalization
Normalization Factory
Range Normalization
Running Mean Std
Running Quantile
Statistics
Utils
Patch Extractor
Patch Extractor
Limit File Extractor
Patch Construction
Patch Extractor
Patch Filter
Patch Filter
Filtermap Utils
Mask Patch Filter
Max Patch Filter
Mean Std Patch Filter
Patch Filter
Patch Filter Factory
Shannon Patch Filter
Patching
Patching
Fixed Patching
Patching
Patching Factory
Random Patching
Sequential Patching
Stratified Patching
Tiled Patching
Whole Sample Patching
Image IO
Image IO
Read
Read
Get Func
Tiff
Write
Write
Get Func
Tiff
Lightning
Lightning
Grouped Index Sampler
Callbacks
Callbacks
Config Saver Callback
Data Stats Callback
Progress Bar Callback
Stop Prediction Callback
Prediction
Prediction
File Path Utils
Image Write Strategy
Prediction Writer Callback
Tile Write Strategy
Write Strategy
Write Strategy Factory
Zarr Tile Write Strategy
Data
Data
Data Module
Data Module Utils
Grouped Index Sampler
Microsplit Data Module
Modules
Modules
CARE Module
Get Module
Module Utils
N2V Module
VAE Lightning Module
N2V Utils
N2V Utils
N2V Manipulate
Pixel Manipulation
Struct Mask Parameters
Prediction
Prediction
Convert Prediction
Stitch Prediction
LVAE
LVAE
LVAE Convert Outputs
LVAE Prediction
LVAE Stitch Prediction
LVAE Tiling Manager
Utils
Utils
Csv Logger
Load Checkpoint
Losses
Losses
N2V Losses
LVAE
LVAE
Loss Utils
LVAE Loss Factory
LVAE Losses
LVAE Training
LVAE Training
Calibration
Eval Utils
Get Config
Lightning Module
Metrics
Train LVAE
Train Utils
Dataset
Dataset
Config
Lc Dataset
Ms Dataset Ref
Multich Dataset
Multicrop Dset
Multifile Dataset
Types
Utils
Utils
Data Utils
Empty Patch Fetcher
Index Manager
Index Switcher
Metrics
Metrics
Metrics
Psnr
Models
Models
Model Factory
Constraints
Constraints
Model Constraints
Model Constraints Factory
UNet Constraints
LVAE
LVAE
Layers
Likelihoods
LVAE
Noise Models
Stochastic
Utils
Model Utils
Model Utils
Activation
UNet
UNet
Layers
UNet
Utils
Utils
Autocorrelation
Context
Deprecation
Folder Versioning
Get Device
Logging
Plotting
Ram
Reshape Array
Version
Compat
Compat
Careamist
Config
Config
Configuration
Configuration Factories
Augmentations
Augmentations
Normalize Config
Transform Config
Transform Unions
Data
Data
Data Config
Inference Config
Tile Information
Lightning
Lightning
Training Config
Callbacks
Callbacks
Callback Config
Utils
Utils
Configuration IO
Dataset
Dataset
In Memory Dataset
In Memory Pred Dataset
In Memory Tiled Pred Dataset
Iterable Dataset
Iterable Pred Dataset
Iterable Tiled Pred Dataset
Dataset Utils
Dataset Utils
File Utils
Iterate Over Files
Patching
Patching
Patching
Random Patching
Sequential Patching
Validate Patch Dimension
Tiling
Tiling
Collate Tiles
LVAE Tiled Patching
Tiled Patching
Lightning
Lightning
Lightning Module
Predict Data Module
Train Data Module
Callbacks
Callbacks
Hyperparameters Callback
Prediction Writer Callback
Prediction Writer Callback
File Path Utils
Prediction Writer Callback
Write Strategy
Write Strategy Factory
Losses
Losses
Loss Factory
Model IO
Model IO
Bmz IO
Model IO Utils
Bioimage
Bioimage
Bioimage Utils
Cover Factory
Model Description
Prediction Utils
Prediction Utils
Prediction Outputs
Stitch Prediction
Transforms
Transforms
Compose
N2V Manipulate
Normalize
Pixel Manipulation
TTA
Utils
Utils
Path Utils
On this page
compat
Home
API Reference
Compat
Compat
Source
Module providing access to deprecated versions of CAREamics.
Back to top