vgregoire commited on
Commit
81cd110
·
verified ·
1 Parent(s): c601cba

v1.2 dataset card: changelog + variant-count fixes

Browse files
Files changed (1) hide show
  1. README.md +17 -3
README.md CHANGED
@@ -121,7 +121,7 @@ import polars as pl
121
  # Markets metadata (one row per market)
122
  markets = pl.read_parquet("markets.parquet")
123
 
124
- # Wide one-row-per-user terminal PnL across four variants
125
  users = pl.read_parquet("user_pnl_summary.parquet")
126
  print(users.sort("pnl_total", descending=True).head(10))
127
 
@@ -164,7 +164,7 @@ maps to a `config_name` in the loader interface above.
164
 
165
  | Subset | Layout | Rows per | Description |
166
  |---|---|---|---|
167
- | `user_features` | `user_features.parquet` | user | Full-sample behavioral feature vector: trade counts, volume, maker/taker share, holding durations, category concentration, distribution metrics, etc. (~83 columns) |
168
  | `user_pnl_summary` | `user_pnl_summary.parquet` | user | Wide terminal PnL across five variants — base, resolved-only, no-fee, spread-adjusted, spread-adjusted resolved-only — each with a total and a per-category breakdown over seven categories (Sports, Crypto, Finance, Politics, Tech, Culture, Weather). The base variant also carries `portfolio_value` (mark-to-market value of open positions) and `usdc_balance` (cash account) so the realized/unrealized split is recoverable. |
169
 
170
  ### Daily PnL panels
@@ -189,7 +189,7 @@ These store the **daily/monthly delta** in user PnL (`pnl_change`), not the leve
189
  | `pnl_change_daily` | `pnl_change_daily/year=YYYY/month=MM/day=DD/data.parquet` | `(user, day)` | Per-user daily PnL change. |
190
  | `pnl_change_monthly` | `pnl_change_monthly.parquet` | `(user, month)` | Per-user monthly aggregation of the same. |
191
 
192
- For a single point-in-time terminal PnL per user (no forward-filling needed), use `user_pnl_summary` above — it carries the same values plus all four variants and the `portfolio_value` / `usdc_balance` decomposition.
193
 
194
  ### Trade-level data
195
 
@@ -310,6 +310,20 @@ without warranty of any kind, express or implied.
310
 
311
  ## Changelog
312
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
313
  - **v1.1** (2026-06-01) — Corrected PnL panels and per-category breakdowns.
314
  Every PnL-related table (`pnl_daily`, the three `pnl_daily_*` variants,
315
  `pnl_category_daily` and its three variants, `pnl_change_daily`,
 
121
  # Markets metadata (one row per market)
122
  markets = pl.read_parquet("markets.parquet")
123
 
124
+ # Wide one-row-per-user terminal PnL across five variants
125
  users = pl.read_parquet("user_pnl_summary.parquet")
126
  print(users.sort("pnl_total", descending=True).head(10))
127
 
 
164
 
165
  | Subset | Layout | Rows per | Description |
166
  |---|---|---|---|
167
+ | `user_features` | `user_features.parquet` | user | Full-sample behavioral feature vector: trade counts, volume, maker/taker share, holding durations, category concentration, distribution metrics, etc. (87 columns) |
168
  | `user_pnl_summary` | `user_pnl_summary.parquet` | user | Wide terminal PnL across five variants — base, resolved-only, no-fee, spread-adjusted, spread-adjusted resolved-only — each with a total and a per-category breakdown over seven categories (Sports, Crypto, Finance, Politics, Tech, Culture, Weather). The base variant also carries `portfolio_value` (mark-to-market value of open positions) and `usdc_balance` (cash account) so the realized/unrealized split is recoverable. |
169
 
170
  ### Daily PnL panels
 
189
  | `pnl_change_daily` | `pnl_change_daily/year=YYYY/month=MM/day=DD/data.parquet` | `(user, day)` | Per-user daily PnL change. |
190
  | `pnl_change_monthly` | `pnl_change_monthly.parquet` | `(user, month)` | Per-user monthly aggregation of the same. |
191
 
192
+ For a single point-in-time terminal PnL per user (no forward-filling needed), use `user_pnl_summary` above — it carries the same values plus all five variants and the `portfolio_value` / `usdc_balance` decomposition.
193
 
194
  ### Trade-level data
195
 
 
310
 
311
  ## Changelog
312
 
313
+ - **v1.2** (2026-06-14) — Removed 16 maker/taker terminal-PnL columns
314
+ (`pnl_maker_total`, `pnl_taker_total`, and their per-category siblings)
315
+ from `user_pnl_summary`. These were shipped undocumented in v1.1 and the
316
+ per-category role columns did not recombine to the base per-category
317
+ totals for users who acted as both maker and taker (≈17.5% of users), so
318
+ they have been withdrawn. The five documented variants (base, resolved,
319
+ no-fee, spread-adjusted, spread-adjusted resolved-only), their
320
+ per-category breakdowns, and the `portfolio_value` / `usdc_balance`
321
+ decomposition are unchanged. No other table is affected. A user's
322
+ maker-vs-taker activity is still fully recoverable from the `trades`
323
+ table (each row carries `maker_address` and `taker_address`); see the
324
+ [documentation](https://www.vincentgregoire.com/polymarket-users-data)
325
+ recipes.
326
+
327
  - **v1.1** (2026-06-01) — Corrected PnL panels and per-category breakdowns.
328
  Every PnL-related table (`pnl_daily`, the three `pnl_daily_*` variants,
329
  `pnl_category_daily` and its three variants, `pnl_change_daily`,