Skip to content

Commit 4bf60e5

Browse files
committed
updated
1 parent 1046f00 commit 4bf60e5

3 files changed

Lines changed: 118 additions & 65 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# FAIM SDK
22

33
[![PyPI version](https://badge.fury.io/py/faim-sdk.svg)](https://badge.fury.io/py/faim-sdk)
4-
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
4+
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
55
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
66

77
Production-ready Python SDK for FAIM (Foundation AI Models) - a high-performance time-series forecasting platform powered by foundation models.
@@ -315,9 +315,9 @@ See the `examples/` directory for complete Jupyter notebook examples:
315315

316316
## Requirements
317317

318-
- Python >= 3.10
319-
- numpy >= 1.20.0
320-
- pyarrow >= 10.0.0
318+
- Python >= 3.11
319+
- numpy >= 1.26.0
320+
- pyarrow >= 11.0.0
321321
- httpx >= 0.23.0
322322
- pydantic >= 2.0.0
323323

@@ -359,4 +359,4 @@ If you use FAIM in your research, please cite:
359359
year = {2024},
360360
url = {https://github.com/your-org/faim-sdk}
361361
}
362-
```
362+
```

examples/flowstate_simple_example.ipynb

Lines changed: 103 additions & 59 deletions
Large diffs are not rendered by default.

faim_sdk/__init__.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@
5050
ForecastResponse:
5151
Contains prediction outputs (point, quantiles, samples) and metadata.
5252
53+
Evaluation Tools:
54+
The faim_sdk.eval subpackage provides metrics and visualization:
55+
- Metrics: mse, mase, crps_from_quantiles
56+
- Visualization: plot_forecast (requires: pip install faim-sdk[viz])
57+
58+
>>> from faim_sdk.eval import mse, plot_forecast
59+
>>> mse_score = mse(test_data, response.point)
60+
>>> fig, ax = plot_forecast(train_data[0], response.point[0], test_data[0])
61+
5362
Exceptions:
5463
- AuthenticationError: API key issues (401, 403)
5564
- ValidationError: Invalid request parameters (422)
@@ -133,4 +142,4 @@
133142
"ConfigurationError",
134143
]
135144

136-
__version__ = "0.2.0"
145+
__version__ = "0.2.1"

0 commit comments

Comments
 (0)