Skip to content

fix: update README and Taskfile #9

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
shackmann merged 1 commit into from
Aug 27, 2026
Merged

fix: update README and Taskfile #9

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ from jointfm_client import bootstrap_notebook
bootstrap_notebook(add_src_root=True)
```

Run `task setup` first so VS Code can select the checked-in `Python (joint-client-python)` notebook kernel backed by this repository's `.venv`.
Run `task setup` first so VS Code can select the registered `Python (joint-client-python)` notebook kernel backed by this repository's `.venv`.

The bootstrap helper resolves the nearest src-layout Python project root, switches the working directory there, and prepends that project's local `src` tree during development. The examples cover hosted health checks, low-level JSON prediction, mean forecasts, sample forecasts, quantile forecasts, pandas/NumPy result conversion, and CSV forecast workflows. They use `.env.sample` placeholders and checked-in fixture payloads; no real tokens or deployment IDs are stored in notebooks.

Expand Down
2 changes: 1 addition & 1 deletion Taskfile.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tasks:
cmds:
- uv venv --allow-existing --python 3.13.3
- uv sync --all-groups --extra notebooks
- uv run python -m ipykernel install --sys-prefix --name joint-client-python --display-name "Python (joint-client-python)"
- uv run python -m ipykernel install --user --name joint-client-python --display-name "Python (joint-client-python)"
- uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
- task: install:ripgrep
- task: install:typos
Expand Down
Loading