CSA Common Lib

The CSA Common Library, csa_common_lib, is a shared library designed to provide utility modules, class definitions, enumerations, and helper functions for the CSA Prediction Engine Python client. It standardizes and simplifies complex operations across different parts of the system.

Folder Structure

csa_common_lib/
└── classes/                 # Contains class definitions for prediction-related data structures
  ├── prediction_options.py  # Defines options and configurations for predictions
  ├── prediction_receipt.py  # Structures data related to prediction receipts
  └── prediction_results.py  # Contains classes for handling prediction results
└── enum_types/              # Contains enumerations that categorize various elements of the system
   ├── exit_flags.py         # Defines exit flag states used during execution
   ├── functions.py          # Enumerates available functions in the system
   ├── job_types.py          # Enumerates different job types for concurrency
└── helpers/                 # Provides helper functions for common low-level tasks
└── toolbox/                 # General-purpose set of utilities
   ├── classes/              # Utility classes used across various parts of the system
   ├── concurrency/          # Tools for concurrent execution
   ├── database/             # Database-related utilities
   ├── npz/                  # Utilities for handling `.npz` files
   └── stats/                # Provides common statistical functions and tools

Installation

By default, the csa_common_lib is a dependency (requirement) of the api client csa_prediction_engine. To install this package specifically as part of your environment, use:

pip install csa_common_lib

Usage

Here’s an example of how to use the prediction class options from the common library:

from csa_common_lib.classes.prediction_options import {
        PredictionOptions,
        MaxFitOptions,
        GridOptions
    }