Datasets:
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,74 @@
|
|
| 1 |
---
|
| 2 |
-
license:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
license: unknown
|
| 3 |
+
tags:
|
| 4 |
+
- finance
|
| 5 |
+
- stock-market
|
| 6 |
+
- trading
|
| 7 |
+
- backtesting
|
| 8 |
+
- zipline
|
| 9 |
+
- ziplime
|
| 10 |
+
task_categories:
|
| 11 |
+
- time-series-forecasting
|
| 12 |
+
size_categories:
|
| 13 |
+
- 1K<n<10K
|
| 14 |
---
|
| 15 |
+
|
| 16 |
+
# finance-yahoo-test
|
| 17 |
+
|
| 18 |
+
**Status: test / placeholder.** This is a scratch dataset used to validate the ziplime → Hugging Face
|
| 19 |
+
publishing pipeline (schema, partitioning, `ziplime bundle` ingest). Do not use for research or trading
|
| 20 |
+
decisions yet — coverage and update cadence are not finalized.
|
| 21 |
+
|
| 22 |
+
## Overview
|
| 23 |
+
|
| 24 |
+
Daily OHLCV price bars for a small set of US equities, sourced from Yahoo Finance, packaged as a
|
| 25 |
+
[ziplime](https://github.com/Limex-com/ziplime) data bundle. This card documents the format ziplime bundles
|
| 26 |
+
published on the Hub will follow.
|
| 27 |
+
|
| 28 |
+
- **Source:** Yahoo Finance (via `yfinance`)
|
| 29 |
+
- **Frequency:** daily
|
| 30 |
+
- **Format:** Parquet, hive-partitioned
|
| 31 |
+
- **Engine:** loadable directly via `ziplime bundle ingest --bundle-name finance-yahoo-test`
|
| 32 |
+
|
| 33 |
+
## Schema
|
| 34 |
+
|
| 35 |
+
| Column | Type | Description |
|
| 36 |
+
|---|---|---|
|
| 37 |
+
| `symbol` | string | Ticker symbol |
|
| 38 |
+
| `date` | date | Trading session date |
|
| 39 |
+
| `open` | float64 | Open price |
|
| 40 |
+
| `high` | float64 | High price |
|
| 41 |
+
| `low` | float64 | Low price |
|
| 42 |
+
| `close` | float64 | Close price |
|
| 43 |
+
| `volume` | int64 | Volume |
|
| 44 |
+
|
| 45 |
+
## How to load
|
| 46 |
+
|
| 47 |
+
```python
|
| 48 |
+
import polars as pl
|
| 49 |
+
|
| 50 |
+
df = pl.read_parquet("hf://datasets/ZipLime/finance-yahoo-test/data/*.parquet")
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
Or via ziplime directly:
|
| 54 |
+
|
| 55 |
+
```bash
|
| 56 |
+
ziplime bundle ingest --bundle-name finance-yahoo-test --source hf://ZipLime/finance-yahoo-test
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
## Coverage
|
| 60 |
+
|
| 61 |
+
- **Symbols:** [TODO — list or count]
|
| 62 |
+
- **Date range:** [TODO]
|
| 63 |
+
- **Update schedule:** none yet (static test snapshot)
|
| 64 |
+
|
| 65 |
+
## License & source terms
|
| 66 |
+
|
| 67 |
+
Data sourced from Yahoo Finance for testing purposes. **License TBD** — Yahoo Finance data has usage
|
| 68 |
+
restrictions that need review before this dataset is treated as anything beyond an internal test fixture.
|
| 69 |
+
Do not redistribute commercially until this is resolved.
|
| 70 |
+
|
| 71 |
+
## About ziplime
|
| 72 |
+
|
| 73 |
+
ziplime is an open-source backtesting engine (successor to Zipline) with native support for point-in-time
|
| 74 |
+
datasets. [github.com/Limex-com/ziplime](https://github.com/Limex-com/ziplime)
|