API Documentation

The rlish package provides simple and efficient data serialization and deserialization functionalities. Below are the detailed API descriptions for the available modules.

class rlish.save(data, filename, format='pickle')

This function saves your data to a file. You can pick between ‘pickle’ and ‘joblib’ for saving.

How it works:

• Internally saves your data and its format (pickle or joblib) using integrated format header.

• Saves as ‘pickle’ by default

Parameters

datauser-defined

The data you want to save as a file.

filenamestr

Where you want to save your data - just give me the file name.

formatstr, optional

Choose ‘pickle’ or ‘joblib’ to save your data. ‘pickle’ is the default. Tip: Use ‘joblib’ if you’re dealing with large arrays and/or machine learning models.

class rlish.load(filename, what_is=False)

Need your data back? Just tell me the file name and I’ll fetch it for you.

This function remembers how your data was saved, so you don’t need to worry about that.

Returns:

Your data, just as you saved it. No fuss, no muss.

Parameters

filenamestr

The name of the file you want to load your data from.

what_isbool

Prints the format of your loaded file.