Skip to content

Commit

Permalink
docs: Expand installation details (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
baggiponte authored Apr 18, 2024
1 parent ba2348d commit 29b6806
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ pip install functime
pip install "functime[llm,lgb]"
```

- `ann`: To use `ann` (approximate nearest neighbors) forecaster
- `cat`: To use `catboost` forecaster
- `xgb`: To use `xgboost` forecaster
- `lgb`: To use `lightgbm` forecaster
- `llm`: To use the LLM-powered forecast analyst
- `plot`: To use plotting functions
- `ann`: To use `ann` (approximate nearest neighbors) forecaster. This leverages the excellent [lancedb](https://lancedb.github.io/lancedb/).
- `cat`: To use `catboost` forecaster through [`catboost`](https://catboost.ai/).
- `xgb`: To use `xgboost` forecaster through [`xgboost`](https://xgboost.readthedocs.io/en/stable/).
- `lgb`: To use `lightgbm` forecaster. `lightgbm` requires compilation (i.e., a compiler like `cmake` and `libomp`), so please refer to the [installation](https://lightgbm.readthedocs.io/en/latest/Installation-Guide.html#installation-guide) instructions.
- `llm`: To use the LLM-powered forecast analyst. This feature currently uses OpenAI's tokenizers and models.
- `plot`: To use plotting functions. Powered by [`plotly`](https://plotly.com/python/).
7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,10 @@ xfail_strict = true
parallel = true
source = ["tests", "functime"]
context = '${CONTEXT}'

[tool.pyright]
exclude = [
".venv"
]
venvPath = "."
venv = ".venv"

0 comments on commit 29b6806

Please sign in to comment.