Skip to content

Add quick demo snippet to README #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fuwiak merged 1 commit into from
May 28, 2025
Merged

Add quick demo snippet to README #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,24 @@
- Simple generator for producing fake data for experiments
- MCP client for forwarding messages to LLM services

## Quick Demo

Fancy a lightning-fast example? Generate a fake dataset, train a model and
have the metrics sent to your favourite LLM in just a few lines:

```python
from faster_llm.Tools.generate_fake_data import FakeData
from faster_llm.ML.classification import Model
from sklearn.linear_model import LogisticRegression

data = FakeData.classification_data(100)
X = data.drop(columns=["HaveAjob"])
y = data["HaveAjob"]

model = Model(LogisticRegression(max_iter=200), X, y, send_to_llm_flag=True)
print(model._compute_metrics())
```

## Install from PyPI

```bash
Expand Down
Loading