API Documentation Index

PyEarthTools comprises multiple sub-packages which can be used individually or together.

API	How-To Guide	Purpose
Data API	Data How-To	Loading Earth system data sets to xarray for processing
Utils API	n/a (internal)	Code for common functionality across the sub-packages
Pipeline API	Pipeline How-To	Process and normalise Earth system data ready for machine learning
Bundled Models	Model How-To	Maintained versions of specific, bundled models which can be easily trained and run
Training API	n/a (to be done)	Training processes for machine learning models
Tutorial API	n/a (internal)	Contains helper code for data sets used in tutorials
Zoo API	na/ (internal)	Contains code for managing registered models (such as the bundled models)
Evaluation	(to be done)	(Coming soon) Contains code for producing standard evaluations (such as benchmarks and scorecards)