menu
Data

Processors

Processors are objects that define interfaces on how to apply a timeseries function to a series in a DataGrid. These series can be from a DataCoordinate or from another processor which allows for nested processors. Each processor class defines how many series can be passed into the processor and any required or optional parameters for the timeseries functions. DataGrid supports many processors with the ability to seamlessly add more to GS Quant.

Supported Processors

We currently support many processors which are grouped by type. There are also API references for all our processors with detailed descriptions and usage.

Special Processors

Special processors are unlike our normal timeseries processors. They handle special use-cases such as getting data from an Entity or coordinate.

ProcessorDescriptionAPI Reference
CoordinateProcessorReturns data from a Coordinate. See example.Link
EntityProcessorReturns data such as the name or an identifier of a entity in string format.Link

Econometric Processors

Econometrics processors are for standard economic and timeseries analytics operations and other numerical operations which are generally finance-oriented.

ProcessorDescriptionAPI Reference
ChangeProcessorComputes the difference of every value from the initial value of the input series.Link
CorrelationProcessorComputes the rolling correlation of two series.Link
VolatilityProcessorComputes the realized volatility of the input series.Link
SharpeRatioProcessorComputes the Sharpe ratio of the the input seriesLink

Statistics Processors

ProcessorDescriptionAPI Reference
PercentilesProcessorComputes the rolling percentiles over given window.Link

Utility Processors

Utility processors are for generic operations on timeseries which may be useful for your analytics.

ProcessorDescriptionAPI Reference
AppendProcessorAppends two series together.Link

Examples

Coordinate Processor

Below is an example DataGrid with a CoordinateProcessor.

from gs_quant.analytics.datagrid import DataColumn, DataRow, DimensionsOverride, DataGrid
from gs_quant.analytics.processors import LastProcessor, EntityProcessor, CoordinateProcessor
from gs_quant.data import DataDimension
from gs_quant.data.coordinate import DataCoordinate, DataMeasure, DataFrequency
from gs_quant.markets.securities import AssetIdentifier, Asset
from gs_quant.session import GsSession

GsSession.use()

implied_volatility = DataCoordinate(
    measure=DataMeasure.IMPLIED_VOLATILITY,
    dimensions={
        DataDimension.TENOR: "3m",
        DataDimension.RELATIVE_STRIKE: 0.5,
        DataDimension.STRIKE_REFERENCE: "delta"
    },
    frequency=DataFrequency.DAILY,
)

col_1 = DataColumn(name="Name", processor=EntityProcessor(field="name"))
col_2 = DataColumn(name="Tenor", processor=CoordinateProcessor(implied_volatility, dimension=DataDimension.TENOR))
col_3 = DataColumn(name="IV ATM", processor=LastProcessor(implied_volatility))

columns = [col_1, col_2, col_3]

SPX = Asset.get("SPX", AssetIdentifier.BLOOMBERG_ID)

rows = [
    DataRow(SPX),
    DataRow(SPX, overrides=[
        DimensionsOverride(
            column_names=[col_2.name, col_3.name],
            dimensions={DataDimension.TENOR: "6m"},
            coordinate=implied_volatility
        )
    ]),
    DataRow(SPX, overrides=[
        DimensionsOverride(
            column_names=[col_2.name, col_3.name],
            dimensions={DataDimension.TENOR: "1y"},
            coordinate=implied_volatility
        )
    ])
]

datagrid = DataGrid(name="SPX Implied Vol by Tenor", rows=rows, columns=columns)
datagrid.initialize(), datagrid.poll()
print(datagrid.to_frame())

Output

            Name Tenor    IV ATM
0  S&P 500 Index    3m  0.252124
1  S&P 500 Index    6m  0.243322
2  S&P 500 Index    1y  0.231568

Contributing Processors

GS Quant is Open-Source, we encourage users to create and contribute new processors for any new analytics.

All processors must inherit from the BaseProcessor which automatically handles serialization and creating the dependency graph for data fetching and other background logic. Users only need to create the process function that handles calculations and setting the procesor's value.

info

Note

For contributing processors, please send merge requests and reach out to: gs-marquee-markets@gs.com


help

Questions?

Please contact us at gs-marquee-markets@gs.com with any questions or feedback.


Related Content


Certain solutions and Institutional Services described herein are provided via our Marquee platform. The Marquee platform is for institutional and professional clients only. This site is for informational purposes only and does not constitute an offer to provide the Marquee platform services described, nor an offer to sell, or the solicitation of an offer to buy, any security. Some of the services and products described herein may not be available in certain jurisdictions or to certain types of clients. Please contact your Goldman Sachs sales representative with any questions. Any data or market information presented on the site is solely for illustrative purposes. There is no representation that any transaction can or could have been effected on such terms or at such prices. Please see https://www.goldmansachs.com/disclaimer/sec-div-disclaimers-for-electronic-comms.html for additional information.
Transaction Banking services are offered by Goldman Sachs Bank USA (“GS Bank”). GS Bank is a New York State chartered bank, a member of the Federal Reserve System and a Member FDIC.
GS DAP™ is owned and operated by Goldman Sachs. This site is for informational purposes only and does not constitute an offer to provide, or the solicitation of an offer to provide access to or use of GS DAP™. Any subsequent commitment by Goldman Sachs to provide access to and / or use of GS DAP™ would be subject to various conditions, including, amongst others, (i) satisfactory determination and legal review of the structure of any potential product or activity, (ii) receipt of all internal and external approvals (including potentially regulatory approvals); (iii) execution of any relevant documentation in a form satisfactory to Goldman Sachs; and (iv) completion of any relevant system / technology / platform build or adaptation required or desired to support the structure of any potential product or activity.
Mosaic is a service mark of Goldman Sachs & Co. LLC. This service is made available in the United States by Goldman Sachs & Co. LLC and outside of the United States by Goldman Sachs International, or its local affiliates in accordance with applicable law and regulations. Goldman Sachs International and Goldman Sachs & Co. LLC are the distributors of the Goldman Sachs Funds. Depending upon the jurisdiction in which you are located, transactions in non-Goldman Sachs money market funds are affected by either Goldman Sachs & Co. LLC, a member of FINRA, SIPC and NYSE, or Goldman Sachs International. For additional information contact your Goldman Sachs representative. Goldman Sachs & Co. LLC, Goldman Sachs International, Goldman Sachs Liquidity Solutions, Goldman Sachs Asset Management, L.P., and the Goldman Sachs funds available through Goldman Sachs Liquidity Solutions and other affiliated entities, are under the common control of the Goldman Sachs Group, Inc.
© 2024 Goldman Sachs. All rights reserved.