Client Side S3

API reference for sovai.utils.client_side_s3

Module: sovai.utils.client_side_s3

Functions

map_identifier()

def map_identifier(
    input_values,
    input_identifier = 'ticker',
    output_identifier = 'cik',
    trailing_zero_removal = True,
)

Map from one identifier to another using the df_codes DataFrame. Handles string, single-item list, and multiple-item lists as input. Uses vectorization for improved performance.

Parameters

Parameter
Type
Description

input_values

The input identifier value(s) to map from (string, list, or array-like)

input_identifier

The type of input identifier (default: 'ticker')

output_identifier

The type of output identifier (default: 'cik')

trailing_zero_removal

If True, convert CIK to int (default: True)

Returns

: Mapped identifier value(s), same type as input


Last updated