microsoft/qlib · error · NotImplementedError
Please implement the `get_stock_amount` method
Error message
Please implement the `get_stock_amount` method
What it means
Error "Please implement the `get_stock_amount` method" thrown in microsoft/qlib.
Source
Thrown at qlib/backtest/position.py:131
the code of the stock
"""
raise NotImplementedError(f"Please implement the `get_stock_price` method")
def get_stock_amount(self, code: str) -> float:
"""
get the amount of the stock
Parameters
----------
code :
the code of the stock
Returns
-------
float:
the amount of the stock
"""
raise NotImplementedError(f"Please implement the `get_stock_amount` method")
def get_cash(self, include_settle: bool = False) -> float:
"""
Parameters
----------
include_settle:
will the unsettled(delayed) cash included
Default: not include those unavailable cash
Returns
-------
float:
the available(tradable) cash in position
"""
raise NotImplementedError(f"Please implement the `get_cash` method")
def get_stock_amount_dict(self) -> dict:
"""View on GitHub (pinned to 79633dd950)
Solutions
- Implement the `get_stock_amount` method in your Position subclass before calling it.
- Use the built-in Position class which already implements `get_stock_amount`.
When it happens
Trigger: This error is raised at qlib/backtest/position.py:131 when the guard condition fails: "Please implement the `get_stock_amount` method". It triggers when the code path receives input or a state that violates the precondition checked at this point — e.g. an unimplemented abstract method being called, an unsupported argument type/value, or an invalid configuration. To avoid it, satisfy the documented precondition before this call: implement the required method in your subclass, or pass a supported value of the expected type as described by the message.
Common situations: See trigger scenarios.
AI-assisted analysis of microsoft/qlib@79633dd950 (2026-08-15).
Data as JSON: /api/errors/6099ffb206c60227.
Report an issue: GitHub.