rasinmuhammed commited on
Commit
1dd7b89
·
verified ·
1 Parent(s): 27ec678

Card: buy link, preview vs full pack, quick start, honest scope

Browse files
Files changed (1) hide show
  1. README.md +107 -28
README.md CHANGED
@@ -1,21 +1,37 @@
1
  ---
2
  license: cc-by-4.0
3
- pretty_name: Pepperwind Trading Co. (preview)
 
 
4
  version: 1.0.0
5
  size_categories:
6
  - 1M<n<10M
7
  task_categories:
8
  - table-question-answering
9
- - text-to-sql
 
 
10
  tags:
11
  - synthetic
 
 
12
  - tabular
13
  - multi-table
 
 
 
 
 
14
  - e-commerce
15
- - finance
 
 
 
 
16
  - benchmark
17
  - evaluation
18
  - answer-key
 
19
  configs:
20
  - config_name: billing.credit_note
21
  data_files: data/billing/credit_note.parquet
@@ -465,22 +481,51 @@ configs:
465
  data_files: data/support/ticket_tag.parquet
466
  ---
467
 
468
- # Pepperwind Trading Co. (preview)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
469
 
470
- A whole company as data: a spice and tea brand selling in India, the EU and the US, over thirty-six months, across
471
- eleven business systems whose keys agree with each other. Orders reach the ledger, refunds reach support, a campaign
472
- reaches the sessions it brought. Every number on the company's dashboards has an answer key.
473
 
474
- Version 1.0. This preview carries every system on a 1% sample of the customers: **223 tables, 1,818,718 rows**,
475
- with an answer key computed on this sample, the data dictionary, the KPI queries with their values on this preview,
476
- and the public development tasks with their gold.
 
 
 
477
 
478
- Explore it in the browser, with live SQL and the company's story, at
479
- **[misata.studio/pepperwind](https://misata.studio/pepperwind)**.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
480
 
481
  ## Systems
482
 
483
- | System | Tables | Rows | What it holds |
484
  |---|---:|---:|---|
485
  | `core` | 16 | 18,244 | markets, organisation, people, products, SKUs, price lists, warehouses |
486
  | `commerce` | 12 | 89,320 | customers, carts, orders and lines, promotions, referrals, returns, reviews |
@@ -494,30 +539,64 @@ Explore it in the browser, with live SQL and the company's story, at
494
  | `hr` | 13 | 233,316 | employment, contracts, compensation, payroll, attendance, leave, reviews |
495
  | `comms` | 17 | 178,849 | email, chat, calendar, documents, policies, consent, DSARs, audit log |
496
 
497
- ## Files
498
 
499
- - `data/<system>/<table>.parquet`: every table, one Parquet file each (browse them in the viewer above).
500
- - `answer_key/`: the preview's answer key and every KPI's value on it.
501
- - `tasks/`: the public development tasks with their gold answers.
502
- - `docs/`: the data dictionary.
503
- - `pepperwind_preview.zip`: all of the above in one download. `SHA256SUMS` lists every file's checksum.
 
 
 
 
504
 
505
  ```python
506
  import duckdb
507
- duckdb.sql("SELECT market_code, count(*) AS orders FROM 'data/commerce/order.parquet' GROUP BY market_code").show()
 
 
 
 
 
 
 
508
  ```
509
 
510
- ## The full company
511
 
512
- The full pack is every customer over all thirty-six months, with the complete answer key, every KPI's value each month
513
- and the full task bank with its held-out split: [misata.studio/pepperwind](https://misata.studio/pepperwind).
 
 
 
 
514
 
515
  ## Is any of it real?
516
 
517
- No. It is synthetic, made with [Misata](https://misata.studio). No real company, brand, person, address or phone number
518
- is used; every email domain ends in `.example` and every IP address sits in a documentation range.
 
 
519
 
520
- ## Licence
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
521
 
522
- This preview is released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/): share and adapt it, with
523
- credit to Misata.
 
1
  ---
2
  license: cc-by-4.0
3
+ language:
4
+ - en
5
+ pretty_name: Pepperwind Trading Co., a synthetic company dataset (free preview)
6
  version: 1.0.0
7
  size_categories:
8
  - 1M<n<10M
9
  task_categories:
10
  - table-question-answering
11
+ - question-answering
12
+ - tabular-classification
13
+ - time-series-forecasting
14
  tags:
15
  - synthetic
16
+ - synthetic-data
17
+ - fictional-company
18
  - tabular
19
  - multi-table
20
+ - relational
21
+ - sql
22
+ - text-to-sql
23
+ - data-warehouse
24
+ - dbt
25
  - e-commerce
26
+ - subscriptions
27
+ - accounting
28
+ - general-ledger
29
+ - crm
30
+ - product-analytics
31
  - benchmark
32
  - evaluation
33
  - answer-key
34
+ - parquet
35
  configs:
36
  - config_name: billing.credit_note
37
  data_files: data/billing/credit_note.parquet
 
481
  data_files: data/support/ticket_tag.parquet
482
  ---
483
 
484
+ # Pepperwind Trading Co.
485
+
486
+ **A fictional company, built as data.** Every person, order, invoice and journal entry in it is synthetic, generated by
487
+ [Misata](https://www.misata.studio). This repository is the free preview. The full company is available
488
+ [on misata.studio for $30](https://www.misata.studio/pepperwind?utm_source=huggingface&utm_medium=dataset_card).
489
+
490
+ Pepperwind is a spice and tea trader from Kochi that sells in India, Europe and the United States. Over thirty-six
491
+ months, from October 2023 to September 2026, it runs eleven business systems: a storefront, a subscription club,
492
+ a warehouse, a general ledger in three currencies, support, CRM, marketing, product analytics, HR and payroll, and
493
+ company mail and chat. The systems share keys, so a single order can be followed from the customer's session through
494
+ payment, picking, shipping, the ledger and any support ticket it caused.
495
+
496
+ Most sample databases are one schema made for one tutorial. Pepperwind is closer to what you meet at work: several
497
+ systems that each hold part of the story and do not always agree. It comes with an answer key, so you can check your
498
+ results. Pepperwind is not real data, and nothing in it describes a real company or person.
499
 
500
+ ## What people use it for
 
 
501
 
502
+ - Dashboards and BI demos that need more than one fact table
503
+ - SQL, analytics engineering and dbt courses with joins across systems
504
+ - Warehouse and pipeline projects: staging, deduplication, slowly changing dimensions, currency conversion
505
+ - Finance exercises: reconciliation, intercompany, tax and currency
506
+ - Churn, fraud and forecasting models on events with a known cause
507
+ - Testing AI analysts and text-to-SQL features against questions with known answers
508
 
509
+ ## Preview and full pack
510
+
511
+ | | Free preview (this repository) | Full pack |
512
+ |---|---|---|
513
+ | Customers | 1% of consumers; B2B accounts and HR in full | all |
514
+ | Tables | 223 | 223 |
515
+ | Rows | 1,818,718 | 79,233,785 |
516
+ | Months | 36 | 36 |
517
+ | Answer key | computed on the sample | complete |
518
+ | KPIs with their values | on the sample | 92, every month |
519
+ | Graded questions | 129 development questions | 420: 138 development, 282 held-out test |
520
+ | Licence | CC BY 4.0 | commercial use, no resale |
521
+ | Price | free | [$30, one payment](https://www.misata.studio/pepperwind?utm_source=huggingface&utm_medium=dataset_card) |
522
+
523
+ The preview is built the same way as the full pack, with the same tables and columns. Its answers are computed on its
524
+ own rows, so they differ from the full pack's.
525
 
526
  ## Systems
527
 
528
+ | System | Tables | Rows in the preview | What it holds |
529
  |---|---:|---:|---|
530
  | `core` | 16 | 18,244 | markets, organisation, people, products, SKUs, price lists, warehouses |
531
  | `commerce` | 12 | 89,320 | customers, carts, orders and lines, promotions, referrals, returns, reviews |
 
539
  | `hr` | 13 | 233,316 | employment, contracts, compensation, payroll, attendance, leave, reviews |
540
  | `comms` | 17 | 178,849 | email, chat, calendar, documents, policies, consent, DSARs, audit log |
541
 
542
+ ## Quick start
543
 
544
+ Each table is its own config in the viewer above, named `<system>.<table>`.
545
+
546
+ ```python
547
+ from datasets import load_dataset
548
+
549
+ orders = load_dataset("misatadata/pepperwind", "commerce.order", split="train")
550
+ ```
551
+
552
+ Or query the Parquet files directly with DuckDB:
553
 
554
  ```python
555
  import duckdb
556
+
557
+ duckdb.sql("""
558
+ SELECT channel, currency, count(*) AS orders, round(sum(total)) AS revenue
559
+ FROM 'data/commerce/order.parquet'
560
+ WHERE cancelled_at IS NULL
561
+ GROUP BY ALL
562
+ ORDER BY currency, revenue DESC
563
+ """).show()
564
  ```
565
 
566
+ ## Files
567
 
568
+ - `data/<system>/<table>.parquet`: every table, one Parquet file each
569
+ - `answer_key/`: the answer key on this sample: what was planted where, the incidents, and every KPI's value
570
+ - `tasks/public_dev.jsonl`: the development questions with their gold answers
571
+ - `docs/`: the data dictionary, one page per system, and `dictionary.json`
572
+ - `pepperwind_preview.zip`: everything above in one download
573
+ - `SHA256SUMS`: a checksum for every data file
574
 
575
  ## Is any of it real?
576
 
577
+ No. Pepperwind Trading Co. is fictional and every row is synthetic. No real company, brand, person, address or phone
578
+ number is used. Every email domain ends in `.example`, and every IP address is in a reserved documentation or
579
+ benchmarking range. Its patterns come from the business plan it was built to follow, not from any real company's
580
+ records, so use it to build, teach, test and demonstrate, not to draw conclusions about real markets.
581
 
582
+ Before buying the full pack, read [what it is and is not](https://www.misata.studio/pepperwind?utm_source=huggingface&utm_medium=dataset_card#before). Start with this
583
+ preview: if it does not fit what you are building, the full pack will not either.
584
+
585
+ ## Licence and citation
586
+
587
+ This preview is released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Credit it as
588
+ "Pepperwind Trading Co. by Misata". The full pack has its own licence, which allows commercial use and does not allow
589
+ reselling or redistributing the dataset itself.
590
+
591
+ ```bibtex
592
+ @misc{pepperwind2026,
593
+ title = {Pepperwind Trading Co.: a synthetic multi-system company dataset},
594
+ author = {{Misata}},
595
+ year = {2026},
596
+ url = {https://huggingface.co/datasets/misatadata/pepperwind},
597
+ note = {Version 1.0}
598
+ }
599
+ ```
600
 
601
+ Need data shaped to your own business? [Misata](https://www.misata.studio) builds datasets from a description or your schema,
602
+ with the answer key.