From f21f8087a0199295cba041ecd6036cbbc04a4e1c Mon Sep 17 00:00:00 2001 From: GitHub Date: Fri, 1 Nov 2024 10:05:24 +0000 Subject: [PATCH] Code generated by writing-algorithm-api-reference-sphinx-code-generator.py --- Resources/qcalgorithm-api/cfd.html | 12 ++++----- Resources/qcalgorithm-api/crypto-future.html | 12 ++++----- Resources/qcalgorithm-api/crypto.html | 12 ++++----- .../qcalgorithm-api/deployment-target.html | 20 ++++++++++++++ Resources/qcalgorithm-api/equity.html | 12 ++++----- Resources/qcalgorithm-api/forex.html | 12 ++++----- Resources/qcalgorithm-api/future.html | 16 ++++++------ Resources/qcalgorithm-api/index-option.html | 12 ++++----- Resources/qcalgorithm-api/index.html | 12 ++++----- Resources/qcalgorithm-api/option.html | 12 ++++----- .../qcalgorithm-add-option.html | 2 +- .../qcalgorithm-add-universe-selection.html | 4 +-- .../qcalgorithm-add-universe.html | 8 +++--- .../qcalgorithm-api/qcalgorithm-buy.html | 2 +- .../qcalgorithm-consolidate.html | 12 ++++----- .../qcalgorithm-api/qcalgorithm-debug.html | 4 +-- .../qcalgorithm-api/qcalgorithm-error.html | 4 +-- .../qcalgorithm-filtered-identity.html | 4 +-- .../qcalgorithm-api/qcalgorithm-log.html | 4 +-- .../qcalgorithm-on-end-of-day.html | 2 +- .../qcalgorithm-option-chains.html | 4 +-- .../qcalgorithm-api/qcalgorithm-plot.html | 26 +++++++++---------- .../qcalgorithm-register-indicator.html | 18 ++++++------- .../qcalgorithm-api/qcalgorithm-sell.html | 2 +- .../qcalgorithm-set-holdings.html | 2 +- .../qcalgorithm-set-runtime-statistic.html | 2 +- .../qcalgorithm-set-summary-statistic.html | 2 +- .../qcalgorithm-set-universe-selection.html | 4 +-- .../qcalgorithm-api/qcalgorithm-train.html | 4 +-- .../qcalgorithm-warm-up-indicator.html | 20 +++++++------- Resources/qcalgorithm-api/security.html | 12 ++++----- 31 files changed, 147 insertions(+), 127 deletions(-) diff --git a/Resources/qcalgorithm-api/cfd.html b/Resources/qcalgorithm-api/cfd.html index 6922d6e48e..2e3cf74a95 100644 --- a/Resources/qcalgorithm-api/cfd.html +++ b/Resources/qcalgorithm-api/cfd.html @@ -91,7 +91,7 @@

Cfd

Parameters:
@@ -185,7 +185,7 @@

Cfd

Parameters:
@@ -220,7 +220,7 @@

Cfd

Parameters:
@@ -783,7 +783,7 @@

Cfd

Parameters:
@@ -877,7 +877,7 @@

Cfd

Parameters:
@@ -912,7 +912,7 @@

Cfd

Parameters:
diff --git a/Resources/qcalgorithm-api/crypto-future.html b/Resources/qcalgorithm-api/crypto-future.html index 879fe1bd8c..485868f7e7 100644 --- a/Resources/qcalgorithm-api/crypto-future.html +++ b/Resources/qcalgorithm-api/crypto-future.html @@ -100,7 +100,7 @@

CryptoFuture

Parameters:
@@ -194,7 +194,7 @@

CryptoFuture

Parameters:
@@ -229,7 +229,7 @@

CryptoFuture

Parameters:
@@ -791,7 +791,7 @@

CryptoFuture

Parameters:
@@ -885,7 +885,7 @@

CryptoFuture

Parameters:
@@ -920,7 +920,7 @@

CryptoFuture

Parameters:
diff --git a/Resources/qcalgorithm-api/crypto.html b/Resources/qcalgorithm-api/crypto.html index 6bd6493b81..5a7599dd88 100644 --- a/Resources/qcalgorithm-api/crypto.html +++ b/Resources/qcalgorithm-api/crypto.html @@ -91,7 +91,7 @@

Crypto

Parameters:
@@ -185,7 +185,7 @@

Crypto

Parameters:
@@ -220,7 +220,7 @@

Crypto

Parameters:
@@ -773,7 +773,7 @@

Crypto

Parameters:
@@ -867,7 +867,7 @@

Crypto

Parameters:
@@ -902,7 +902,7 @@

Crypto

Parameters:
diff --git a/Resources/qcalgorithm-api/deployment-target.html b/Resources/qcalgorithm-api/deployment-target.html index 67caa6f85f..eba1f53b59 100644 --- a/Resources/qcalgorithm-api/deployment-target.html +++ b/Resources/qcalgorithm-api/deployment-target.html @@ -24,6 +24,16 @@

DeploymentTarget

DeploymentTarget

+
field PRIVATE_CLOUD_PLATFORM
+
+

Private Cloud Platform (2)

+ +
Returns:
+

Private Cloud Platform (2)

+
Return type:
+

DeploymentTarget

+
+
@@ -52,5 +62,15 @@

DeploymentTarget

DeploymentTarget

+
field PrivateCloudPlatform
+
+

Private Cloud Platform (2)

+ +
Returns:
+

Private Cloud Platform (2)

+
Return type:
+

DeploymentTarget

+
+ diff --git a/Resources/qcalgorithm-api/equity.html b/Resources/qcalgorithm-api/equity.html index 9b1bd22b62..22f66f8043 100644 --- a/Resources/qcalgorithm-api/equity.html +++ b/Resources/qcalgorithm-api/equity.html @@ -103,7 +103,7 @@

Equity

Parameters:
@@ -197,7 +197,7 @@

Equity

Parameters:
@@ -232,7 +232,7 @@

Equity

Parameters:
@@ -839,7 +839,7 @@

Equity

Parameters:
@@ -933,7 +933,7 @@

Equity

Parameters:
@@ -968,7 +968,7 @@

Equity

Parameters:
diff --git a/Resources/qcalgorithm-api/forex.html b/Resources/qcalgorithm-api/forex.html index 80348098cc..672790c289 100644 --- a/Resources/qcalgorithm-api/forex.html +++ b/Resources/qcalgorithm-api/forex.html @@ -91,7 +91,7 @@

Forex

Parameters:
@@ -185,7 +185,7 @@

Forex

Parameters:
@@ -220,7 +220,7 @@

Forex

Parameters:
@@ -773,7 +773,7 @@

Forex

Parameters:
@@ -867,7 +867,7 @@

Forex

Parameters:
@@ -902,7 +902,7 @@

Forex

Parameters:
diff --git a/Resources/qcalgorithm-api/future.html b/Resources/qcalgorithm-api/future.html index fd3f801399..1119aa8b9a 100644 --- a/Resources/qcalgorithm-api/future.html +++ b/Resources/qcalgorithm-api/future.html @@ -91,7 +91,7 @@

Future

Parameters:
@@ -131,7 +131,7 @@

Future

Parameters:
@@ -225,7 +225,7 @@

Future

Parameters:
@@ -260,7 +260,7 @@

Future

Parameters:
@@ -895,7 +895,7 @@

Future

Parameters:
@@ -935,7 +935,7 @@

Future

Parameters:
@@ -1029,7 +1029,7 @@

Future

Parameters:
@@ -1064,7 +1064,7 @@

Future

Parameters:
diff --git a/Resources/qcalgorithm-api/index-option.html b/Resources/qcalgorithm-api/index-option.html index 9bf42ed21f..980df4e91f 100644 --- a/Resources/qcalgorithm-api/index-option.html +++ b/Resources/qcalgorithm-api/index-option.html @@ -199,7 +199,7 @@

IndexOption

Parameters:
@@ -391,7 +391,7 @@

IndexOption

Parameters:
@@ -426,7 +426,7 @@

IndexOption

Parameters:
@@ -1227,7 +1227,7 @@

IndexOption

Parameters:
@@ -1419,7 +1419,7 @@

IndexOption

Parameters:
@@ -1454,7 +1454,7 @@

IndexOption

Parameters:
diff --git a/Resources/qcalgorithm-api/index.html b/Resources/qcalgorithm-api/index.html index 461f771cf8..02b72e8b7b 100644 --- a/Resources/qcalgorithm-api/index.html +++ b/Resources/qcalgorithm-api/index.html @@ -91,7 +91,7 @@

Index

Parameters:
@@ -185,7 +185,7 @@

Index

Parameters:
@@ -220,7 +220,7 @@

Index

Parameters:
@@ -763,7 +763,7 @@

Index

Parameters:
@@ -857,7 +857,7 @@

Index

Parameters:
@@ -892,7 +892,7 @@

Index

Parameters:
diff --git a/Resources/qcalgorithm-api/option.html b/Resources/qcalgorithm-api/option.html index 270099f653..33d580cd0c 100644 --- a/Resources/qcalgorithm-api/option.html +++ b/Resources/qcalgorithm-api/option.html @@ -199,7 +199,7 @@

Option

Parameters:
@@ -391,7 +391,7 @@

Option

Parameters:
@@ -426,7 +426,7 @@

Option

Parameters:
@@ -1249,7 +1249,7 @@

Option

Parameters:
@@ -1441,7 +1441,7 @@

Option

Parameters:
@@ -1476,7 +1476,7 @@

Option

Parameters:
diff --git a/Resources/qcalgorithm-api/qcalgorithm-add-option.html b/Resources/qcalgorithm-api/qcalgorithm-add-option.html index e1788513df..b80df63ebd 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-add-option.html +++ b/Resources/qcalgorithm-api/qcalgorithm-add-option.html @@ -5,7 +5,7 @@
Parameters:
@@ -74,7 +74,7 @@ date_rule (IDateRule)
  • - selector (List[BaseData, str] | List[Fundamental, Symbol] | List[BaseData, Symbol]) — Defines an initial coarse selection + selector (List[BaseData, Symbol] | List[Fundamental, Symbol] | List[BaseData, str]) — Defines an initial coarse selection
    • @@ -161,7 +161,7 @@ universeSettings (UniverseSettings) — The subscription settings to use for newly created subscriptions
  • - selector (IEnumerable[Fundamental, Symbol] | IEnumerable[DateTime, String] | IEnumerable[BaseData, String] | IEnumerable[BaseData, Symbol] | PyObject) — Function delegate that performs selection on the universe data + selector (PyObject | IEnumerable[Fundamental, Symbol] | IEnumerable[BaseData, Symbol] | IEnumerable[BaseData, String] | IEnumerable[DateTime, String]) — Function delegate that performs selection on the universe data
    • @@ -212,7 +212,7 @@ dateRule (IDateRule)
  • - selector (IEnumerable[BaseData, String] | IEnumerable[BaseData, Symbol] | IEnumerable[Fundamental, Symbol]) — Defines an initial coarse selection + selector (IEnumerable[Fundamental, Symbol] | IEnumerable[BaseData, Symbol] | IEnumerable[BaseData, String]) — Defines an initial coarse selection
    • diff --git a/Resources/qcalgorithm-api/qcalgorithm-buy.html b/Resources/qcalgorithm-api/qcalgorithm-buy.html index 2339af654b..0af9dcd60c 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-buy.html +++ b/Resources/qcalgorithm-api/qcalgorithm-buy.html @@ -83,7 +83,7 @@ symbol (Symbol) — string Symbol of the asset to trade
  • - quantity (Single | Decimal | Int32 | Double) — int Quantity of the asset to trade + quantity (Decimal | Int32 | Double | Single) — int Quantity of the asset to trade
    • Returns:
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-consolidate.html b/Resources/qcalgorithm-api/qcalgorithm-consolidate.html index 3b8819aa51..abc72c8106 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-consolidate.html +++ b/Resources/qcalgorithm-api/qcalgorithm-consolidate.html @@ -14,7 +14,7 @@ tick_type (TickType) — The consolidation period
  • - handler (Action[TradeBar] | None | Action[QuoteBar] | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found. + handler (Action[TradeBar] | Action[QuoteBar] | None | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found.
    • Returns:
    @@ -24,7 +24,7 @@
    -
    consolidate(symbol, calendar, tick_type, handler)[source]
    +
    consolidate(symbol, calendar, tick_type, handler)[source]

    Registers the handler to receive consolidated data for the specified symbol

    Parameters:
    @@ -39,7 +39,7 @@ tick_type (TickType) — The consolidation calendar
  • - handler (Action[TradeBar] | None | Action[QuoteBar] | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found. + handler (Action[TradeBar] | Action[QuoteBar] | None | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found.
    • Returns:
    @@ -64,7 +64,7 @@ tickType (TickType) — The consolidation period
  • - handler (Action[TradeBar] | None | Action[QuoteBar] | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found. + handler (Action[TradeBar] | Action[QuoteBar] | None | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found.
    • Returns:
    @@ -74,7 +74,7 @@
    -
    Consolidate(symbol, calendar, tickType, handler)[source]
    +
    Consolidate(symbol, calendar, tickType, handler)[source]

    Registers the handler to receive consolidated data for the specified symbol

    Parameters:
    @@ -89,7 +89,7 @@ tickType (TickType) — The consolidation calendar
  • - handler (Action[TradeBar] | None | Action[QuoteBar] | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found. + handler (Action[TradeBar] | Action[QuoteBar] | None | PyObject) — The tick type of subscription used as data source for consolidator. Specify null to use first subscription found.
    • Returns:
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-debug.html b/Resources/qcalgorithm-api/qcalgorithm-debug.html index 2b0de08d69..f7a06acd9b 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-debug.html +++ b/Resources/qcalgorithm-api/qcalgorithm-debug.html @@ -5,7 +5,7 @@
    Parameters:
    • - message (str | float | PyObject | int) — Message to send to debug console + message (PyObject | str | float | int) — Message to send to debug console
    @@ -18,7 +18,7 @@
    Parameters:
    • - message (Double | Decimal | Int32 | String | PyObject) — Message to send to debug console + message (Decimal | Int32 | String | Double | PyObject) — Message to send to debug console
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-error.html b/Resources/qcalgorithm-api/qcalgorithm-error.html index 8ae9b2f974..23692b613b 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-error.html +++ b/Resources/qcalgorithm-api/qcalgorithm-error.html @@ -5,7 +5,7 @@
    Parameters:
    • - message (str | float | PyObject | int) — Message to display in errors grid + message (PyObject | str | float | int) — Message to display in errors grid
    @@ -31,7 +31,7 @@
    Parameters:
    • - message (Double | Decimal | Int32 | String | PyObject) — Message to display in errors grid + message (Decimal | Int32 | String | Double | PyObject) — Message to display in errors grid
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-filtered-identity.html b/Resources/qcalgorithm-api/qcalgorithm-filtered-identity.html index 857903ce06..b0f02bbb8f 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-filtered-identity.html +++ b/Resources/qcalgorithm-api/qcalgorithm-filtered-identity.html @@ -14,7 +14,7 @@ selector (Callable[IBaseData, IBaseDataBar] | PyObject, optional) — x.Value)
  • - filter (PyObject | Callable[IBaseData, bool], optional) — true) which means no filter + filter (Callable[IBaseData, bool] | PyObject, optional) — true) which means no filter
  • field_name (str, optional) — The name of the field being selected @@ -42,7 +42,7 @@ selector (Func[IBaseData, IBaseDataBar] | PyObject, optional) — x.Value)
  • - filter (Func[IBaseData, Boolean] | PyObject, optional) — true) which means no filter + filter (PyObject | Func[IBaseData, Boolean], optional) — true) which means no filter
  • fieldName (string, optional) — The name of the field being selected diff --git a/Resources/qcalgorithm-api/qcalgorithm-log.html b/Resources/qcalgorithm-api/qcalgorithm-log.html index 84d653e7ce..28adbb59c1 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-log.html +++ b/Resources/qcalgorithm-api/qcalgorithm-log.html @@ -5,7 +5,7 @@
    Parameters:
    • - message (str | float | PyObject | int) — String message to log. + message (PyObject | str | float | int) — String message to log.
    @@ -18,7 +18,7 @@
    Parameters:
    • - message (Double | Decimal | Int32 | String | PyObject) — String message to log. + message (Decimal | Int32 | String | Double | PyObject) — String message to log.
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-on-end-of-day.html b/Resources/qcalgorithm-api/qcalgorithm-on-end-of-day.html index 69435b3d05..a0dcde6155 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-on-end-of-day.html +++ b/Resources/qcalgorithm-api/qcalgorithm-on-end-of-day.html @@ -5,7 +5,7 @@
    Parameters:
    • - symbol (str | Symbol) — Asset symbol for this end of day event. Forex and equities have different closing hours. + symbol (Symbol | str) — Asset symbol for this end of day event. Forex and equities have different closing hours.
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-option-chains.html b/Resources/qcalgorithm-api/qcalgorithm-option-chains.html index ff6bcf4873..f5ecb9dd4c 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-option-chains.html +++ b/Resources/qcalgorithm-api/qcalgorithm-option-chains.html @@ -1,5 +1,5 @@
    -
    option_chains(symbols)[source]
    +
    option_chains(symbols)[source]

    Get the option chains for the specified symbols at the current time (Time)

    Parameters:
    @@ -15,7 +15,7 @@
    -
    OptionChains(symbols)[source]
    +
    OptionChains(symbols)[source]

    Get the option chains for the specified symbols at the current time (Time)

    Parameters:
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-plot.html b/Resources/qcalgorithm-api/qcalgorithm-plot.html index adc352e914..aa557e3230 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-plot.html +++ b/Resources/qcalgorithm-api/qcalgorithm-plot.html @@ -36,16 +36,16 @@ chart (str) — The chart's name
  • - first (Indicator | TradeBarIndicator | BarIndicator) — The first indicator to plot + first (TradeBarIndicator | BarIndicator | Indicator) — The first indicator to plot
  • - second (Indicator | TradeBarIndicator | BarIndicator, optional) — The second indicator to plot + second (TradeBarIndicator | BarIndicator | Indicator, optional) — The second indicator to plot
  • - third (Indicator | TradeBarIndicator | BarIndicator, optional) — The third indicator to plot + third (TradeBarIndicator | BarIndicator | Indicator, optional) — The third indicator to plot
  • - fourth (Indicator | TradeBarIndicator | BarIndicator, optional) — The fourth indicator to plot + fourth (TradeBarIndicator | BarIndicator | Indicator, optional) — The fourth indicator to plot
    • @@ -134,16 +134,16 @@ series (string) — Series name
  • - open (Single | Decimal | Int32 | Double) — The candlestick open value + open (Decimal | Int32 | Double | Single) — The candlestick open value
  • - high (Single | Decimal | Int32 | Double) — The candlestick high value + high (Decimal | Int32 | Double | Single) — The candlestick high value
  • - low (Single | Decimal | Int32 | Double) — The candlestick low value + low (Decimal | Int32 | Double | Single) — The candlestick low value
  • - close (Single | Decimal | Int32 | Double) — The candlestick close value + close (Decimal | Int32 | Double | Single) — The candlestick close value
    • @@ -159,16 +159,16 @@ chart (string) — The chart's name
  • - first (Indicator | TradeBarIndicator | BarIndicator) — The first indicator to plot + first (TradeBarIndicator | BarIndicator | Indicator) — The first indicator to plot
  • - second (Indicator | TradeBarIndicator | BarIndicator, optional) — The second indicator to plot + second (TradeBarIndicator | BarIndicator | Indicator, optional) — The second indicator to plot
  • - third (Indicator | TradeBarIndicator | BarIndicator, optional) — The third indicator to plot + third (TradeBarIndicator | BarIndicator | Indicator, optional) — The third indicator to plot
  • - fourth (Indicator | TradeBarIndicator | BarIndicator, optional) — The fourth indicator to plot + fourth (TradeBarIndicator | BarIndicator | Indicator, optional) — The fourth indicator to plot
    • @@ -187,7 +187,7 @@ series (string)
  • - value (Single | Decimal | Int32 | Double) + value (Decimal | Int32 | Double | Single)
    • diff --git a/Resources/qcalgorithm-api/qcalgorithm-register-indicator.html b/Resources/qcalgorithm-api/qcalgorithm-register-indicator.html index a0805d4765..93c97a5b9e 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-register-indicator.html +++ b/Resources/qcalgorithm-api/qcalgorithm-register-indicator.html @@ -8,13 +8,13 @@ symbol (Symbol) — The symbol to register against
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator to receive data from the consolidator + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator to receive data from the consolidator
  • resolution (Optional[Resolution] | Optional[timedelta]) — The resolution at which to send data to the indicator, null to use the same resolution as the subscription
  • - selector (Callable[IBaseData, float] | None | PyObject) — (T)x) + selector (None | Callable[IBaseData, float] | PyObject) — (T)x)
    • @@ -52,13 +52,13 @@ symbol (Symbol) — The symbol to register against
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator to receive data from the consolidator + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator to receive data from the consolidator
  • consolidator (IDataConsolidator) — The consolidator to receive raw subscription data
  • - selector (Callable[IBaseData, float] | None | PyObject, optional) — (T)x) + selector (None | Callable[IBaseData, float] | PyObject, optional) — (T)x)
    • @@ -74,13 +74,13 @@ symbol (Symbol) — The symbol to register against
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator to receive data from the consolidator + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator to receive data from the consolidator
  • - resolution (Nullable[TimeSpan] | Nullable[Resolution]) — The resolution at which to send data to the indicator, null to use the same resolution as the subscription + resolution (Nullable[Resolution] | Nullable[TimeSpan]) — The resolution at which to send data to the indicator, null to use the same resolution as the subscription
  • - selector (Func[IBaseData, Decimal] | None | PyObject) — (T)x) + selector (None | Func[IBaseData, Decimal] | PyObject) — (T)x)
    • @@ -118,13 +118,13 @@ symbol (Symbol) — The symbol to register against
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator to receive data from the consolidator + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator to receive data from the consolidator
  • consolidator (IDataConsolidator) — The consolidator to receive raw subscription data
  • - selector (Func[IBaseData, Decimal] | None | PyObject, optional) — (T)x) + selector (None | Func[IBaseData, Decimal] | PyObject, optional) — (T)x)
    • diff --git a/Resources/qcalgorithm-api/qcalgorithm-sell.html b/Resources/qcalgorithm-api/qcalgorithm-sell.html index ca94c7204e..b1bd4fac25 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-sell.html +++ b/Resources/qcalgorithm-api/qcalgorithm-sell.html @@ -83,7 +83,7 @@ symbol (Symbol) — string Symbol of the asset to trade
  • - quantity (Single | Decimal | Int32 | Double) — int Quantity of the asset to trade + quantity (Decimal | Int32 | Double | Single) — int Quantity of the asset to trade
    • Returns:
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-set-holdings.html b/Resources/qcalgorithm-api/qcalgorithm-set-holdings.html index d60c3ac322..767b012508 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-set-holdings.html +++ b/Resources/qcalgorithm-api/qcalgorithm-set-holdings.html @@ -55,7 +55,7 @@ symbol (Symbol) — string symbol we wish to hold
  • - percentage (Single | Decimal | Int32 | Double) — double percentage of holdings desired + percentage (Decimal | Int32 | Double | Single) — double percentage of holdings desired
  • liquidateExistingHoldings (bool, optional) — liquidate existing holdings if necessary to hold this stock diff --git a/Resources/qcalgorithm-api/qcalgorithm-set-runtime-statistic.html b/Resources/qcalgorithm-api/qcalgorithm-set-runtime-statistic.html index df26e2030f..9990f519b6 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-set-runtime-statistic.html +++ b/Resources/qcalgorithm-api/qcalgorithm-set-runtime-statistic.html @@ -24,7 +24,7 @@ name (string) — Name of your runtime statistic
  • - value (String | Decimal | Int32 | Double) — String value of your runtime statistic + value (Decimal | Int32 | String | Double) — String value of your runtime statistic
    • diff --git a/Resources/qcalgorithm-api/qcalgorithm-set-summary-statistic.html b/Resources/qcalgorithm-api/qcalgorithm-set-summary-statistic.html index 550dfef541..d34d2d4863 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-set-summary-statistic.html +++ b/Resources/qcalgorithm-api/qcalgorithm-set-summary-statistic.html @@ -24,7 +24,7 @@ name (string) — Name of the custom summary statistic
  • - value (String | Decimal | Int32 | Double) — Value of the custom summary statistic + value (Decimal | Int32 | String | Double) — Value of the custom summary statistic
    • diff --git a/Resources/qcalgorithm-api/qcalgorithm-set-universe-selection.html b/Resources/qcalgorithm-api/qcalgorithm-set-universe-selection.html index a3ba7c6738..a541917128 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-set-universe-selection.html +++ b/Resources/qcalgorithm-api/qcalgorithm-set-universe-selection.html @@ -5,7 +5,7 @@
    Parameters:
    • - universe_selection (PyObject | IUniverseSelectionModel) — Model defining universes for the algorithm + universe_selection (IUniverseSelectionModel | PyObject) — Model defining universes for the algorithm
    @@ -18,7 +18,7 @@
    Parameters:
    • - universeSelection (PyObject | IUniverseSelectionModel) — Model defining universes for the algorithm + universeSelection (IUniverseSelectionModel | PyObject) — Model defining universes for the algorithm
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-train.html b/Resources/qcalgorithm-api/qcalgorithm-train.html index 156cd68e63..0dba33387b 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-train.html +++ b/Resources/qcalgorithm-api/qcalgorithm-train.html @@ -1,5 +1,5 @@
    -
    train(date_rule, time_rule, training_code)[source]
    +
    train(date_rule, time_rule, training_code)[source]

    Schedules the provided training code to execute immediately

    Parameters:
    @@ -20,7 +20,7 @@
    -
    Train(dateRule, timeRule, trainingCode)[source]
    +
    Train(dateRule, timeRule, trainingCode)[source]

    Schedules the provided training code to execute immediately

    Parameters:
    diff --git a/Resources/qcalgorithm-api/qcalgorithm-warm-up-indicator.html b/Resources/qcalgorithm-api/qcalgorithm-warm-up-indicator.html index c2ada7f9d2..e3742f1070 100644 --- a/Resources/qcalgorithm-api/qcalgorithm-warm-up-indicator.html +++ b/Resources/qcalgorithm-api/qcalgorithm-warm-up-indicator.html @@ -8,13 +8,13 @@ symbol (Symbol) — The symbol whose indicator we want
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator we want to warm up + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator we want to warm up
  • resolution (Resolution, optional) — The resolution
  • - selector (Callable[IBaseData, float] | None | PyObject, optional) — (T)x) + selector (None | Callable[IBaseData, float] | PyObject, optional) — (T)x)
    • @@ -30,13 +30,13 @@ symbol (Symbol) — The symbol whose indicator we want
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator we want to warm up + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator we want to warm up
  • period (timedelta) — The necessary period to warm up the indicator
  • - selector (Callable[IBaseData, float] | None | PyObject, optional) — (T)x) + selector (None | Callable[IBaseData, float] | PyObject, optional) — (T)x)
    • @@ -58,7 +58,7 @@ resolution (Resolution, optional) — The resolution
  • - selector (Callable[IBaseData, float] | None, optional) — x.Value) + selector (None | Callable[IBaseData, float], optional) — x.Value)
    • @@ -74,13 +74,13 @@ symbol (Symbol) — The symbol whose indicator we want
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator we want to warm up + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator we want to warm up
  • resolution (Resolution, optional) — The resolution
  • - selector (Func[IBaseData, Decimal] | None | PyObject, optional) — (T)x) + selector (None | Func[IBaseData, Decimal] | PyObject, optional) — (T)x)
    • @@ -96,13 +96,13 @@ symbol (Symbol) — The symbol whose indicator we want
  • - indicator (None | PyObject | IndicatorBase[IndicatorDataPoint]) — The indicator we want to warm up + indicator (None | IndicatorBase[IndicatorDataPoint] | PyObject) — The indicator we want to warm up
  • period (TimeSpan) — The necessary period to warm up the indicator
  • - selector (Func[IBaseData, Decimal] | None | PyObject, optional) — (T)x) + selector (None | Func[IBaseData, Decimal] | PyObject, optional) — (T)x)
    • @@ -124,7 +124,7 @@ resolution (Resolution, optional) — The resolution
  • - selector (Func[IBaseData, Decimal] | None, optional) — x.Value) + selector (None | Func[IBaseData, Decimal], optional) — x.Value)
    • diff --git a/Resources/qcalgorithm-api/security.html b/Resources/qcalgorithm-api/security.html index 0e3d2e16e0..cd8343c028 100644 --- a/Resources/qcalgorithm-api/security.html +++ b/Resources/qcalgorithm-api/security.html @@ -91,7 +91,7 @@

    Security

    Parameters:
    • - fill_model (PyObject | IFillModel) + fill_model (IFillModel | PyObject)
    @@ -185,7 +185,7 @@

    Security

    Parameters:
    • - settlement_model (ISettlementModel | PyObject) + settlement_model (PyObject | ISettlementModel)
    @@ -220,7 +220,7 @@

    Security

    Parameters:
    • - slippage_model (ISlippageModel | PyObject) + slippage_model (PyObject | ISlippageModel)
    @@ -775,7 +775,7 @@

    Security

    Parameters:
    • - fillModel (PyObject | IFillModel) + fillModel (IFillModel | PyObject)
    @@ -869,7 +869,7 @@

    Security

    Parameters:
    • - settlementModel (ISettlementModel | PyObject) + settlementModel (PyObject | ISettlementModel)
    @@ -904,7 +904,7 @@

    Security

    Parameters:
    • - slippageModel (ISlippageModel | PyObject) + slippageModel (PyObject | ISlippageModel)