Skip to content

Commit

Permalink
Updating Metaculus models
Browse files Browse the repository at this point in the history
  • Loading branch information
kongzii committed Oct 9, 2024
1 parent 2335bae commit 7572fe3
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 73 deletions.
124 changes: 58 additions & 66 deletions prediction_market_agent_tooling/markets/metaculus/data_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,93 +3,85 @@

from pydantic import BaseModel

from prediction_market_agent_tooling.gtypes import Probability
from prediction_market_agent_tooling.tools.utils import DatetimeUTC


class QuestionType(str, Enum):
forecast = "forecast"
notebook = "notebook"
discussion = "discussion"
claim = "claim"
group = "group"
conditional_group = "conditional_group"
multiple_choice = "multiple_choice"
binary = "binary"


class CommunityPrediction(BaseModel):
y: list[float]
q1: float | None = None
q2: float | None = None
q3: float | None = None
class AggregationItem(BaseModel):
start_time: DatetimeUTC
end_time: DatetimeUTC | None
forecast_values: list[float] | None
forecaster_count: int
interval_lower_bounds: list[float] | None
centers: list[float] | None
interval_upper_bounds: list[float] | None
means: list[float] | None
histogram: list[float] | None

@property
def p_yes(self) -> float:
"""
q2 corresponds to the median, or 'second quartile' of the distribution.
If no value is provided (i.e. the question is new and has not been
answered yet), we default to 0.5.
"""
return self.q2 if self.q2 is not None else 0.5

class Aggregation(BaseModel):
history: list[AggregationItem]
latest: AggregationItem | None
score_data: dict[str, Any]

class Prediction(BaseModel):
t: DatetimeUTC
x: float

class Aggregations(BaseModel):
recency_weighted: Aggregation
unweighted: Aggregation
single_aggregation: Aggregation
metaculus_prediction: Aggregation

class UserPredictions(BaseModel):
id: int
predictions: list[Prediction]
points_won: float | None = None
user: int
username: str
question: int


class CommunityPredictionStats(BaseModel):
full: CommunityPrediction
unweighted: CommunityPrediction
class Question(BaseModel):
aggregations: Aggregations
my_forecasts: Aggregation
type: QuestionType
possibilities: dict[str, str] | None


class MetaculusQuestion(BaseModel):
"""
https://www.metaculus.com/api2/schema/redoc/#tag/questions/operation/questions_retrieve
"""

active_state: Any
url: str
page_url: str
id: int
author: int
author_name: str
author_id: int
author_username: str
title: str
title_short: str
group_label: str | None = None
resolution: int | None
resolved_option: int | None
created_time: DatetimeUTC
publish_time: DatetimeUTC | None = None
close_time: DatetimeUTC | None = None
effected_close_time: DatetimeUTC | None
resolve_time: DatetimeUTC | None = None
possibilities: dict[Any, Any] | None = None
scoring: dict[Any, Any] = {}
type: QuestionType | None = None
user_perms: Any
weekly_movement: float | None
weekly_movement_direction: int | None = None
cp_reveal_time: DatetimeUTC | None = None
edited_time: DatetimeUTC
last_activity_time: DatetimeUTC
activity: float
created_at: DatetimeUTC
published_at: DatetimeUTC
scheduled_close_time: DatetimeUTC
scheduled_resolve_time: DatetimeUTC
user_permission: str
comment_count: int
votes: int
community_prediction: CommunityPredictionStats
my_predictions: UserPredictions | None = None
question: Question
# TODO add the rest of the fields https://github.com/gnosis/prediction-market-agent-tooling/issues/301

@property
def page_url(self) -> str:
return f"https://www.metaculus.com/questions/{self.id}/"

@property
def p_yes(self) -> Probability:
if self.question.type != QuestionType.binary:
raise ValueError(f"Only binary markets can have p_yes.")
if (
self.question.aggregations.recency_weighted is None
or self.question.aggregations.recency_weighted.latest is None
or self.question.aggregations.recency_weighted.latest.forecast_values
is None
):
# If no value is provided (i.e. the question is new and has not been answered yet), we default to 0.5.
return Probability(0.5)
if len(self.question.aggregations.recency_weighted.latest.forecast_values) != 2:
raise ValueError(
f"Invalid logic, assumed that binary markets will have two forecasts, got: {self.question.aggregations.recency_weighted.latest.forecast_values}"
)
# Experimentally figured out that they store "Yes" at index 1.
return Probability(
self.question.aggregations.recency_weighted.latest.forecast_values[1]
)


class MetaculusQuestions(BaseModel):
next: str | None
Expand Down
11 changes: 5 additions & 6 deletions prediction_market_agent_tooling/markets/metaculus/metaculus.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,12 @@ def from_data_model(model: MetaculusQuestion) -> "MetaculusAgentMarket":
question=model.title,
outcomes=[],
resolution=None,
current_p_yes=Probability(model.community_prediction.full.p_yes),
created_time=model.created_time,
close_time=model.close_time,
url=model.url,
current_p_yes=model.p_yes,
created_time=model.created_at,
close_time=model.scheduled_close_time,
url=model.page_url,
volume=None,
have_predicted=model.my_predictions is not None
and len(model.my_predictions.predictions) > 0,
have_predicted=model.question.my_forecasts.latest is not None,
outcome_token_pool=None,
)

Expand Down
2 changes: 1 addition & 1 deletion tests/markets/test_markets.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def test_get_pool_tokens(market_type: MarketType) -> None:

@pytest.mark.parametrize("market_type", list(MarketType))
def test_get_markets(market_type: MarketType) -> None:
limit = 10
limit = 100
markets = market_type.market_class.get_binary_markets(
limit=limit, sort_by=SortBy.NONE, filter_by=FilterBy.OPEN
)
Expand Down

0 comments on commit 7572fe3

Please sign in to comment.