Installation¶
Getting ForML¶
To install the prepackaged version of ForML simply use pip:
$ pip install forml
Dependency Constraints¶
Being a framework, the ForML distribution package comes with unpinned dependencies to give enough
flexibility to the client applications. For reproducibility, there is the constraints.txt
constraints file provided to offer a known-to-be-working
combination of all the dependencies used by ForML. To install ForML using these dependencies,
simply add the --constraint
to (any of the mentioned) pip install
commands:
$ pip install --constraint https://raw.githubusercontent.com/formlio/forml/main/constraints.txt forml
Extra Features¶
ForML has several optional features with their own dependencies which can be pulled-in during the installation like this:
$ pip install 'forml[dask,graphviz,rest]'
Some of the features might have additional binary dependencies that need to be resolved using a system-dependent mechanism (i.e. using the OS package manager).
Feature |
Install Command |
Description |
---|---|---|
all |
|
All providers (all extras without |
dask |
|
The |
dev |
|
ForML development tools |
docs |
|
Documentation publishing dependencies |
graphviz |
|
|
mlflow |
|
|
rest |
|
|
spark |
|
The |
sql |
|
SQL reader dependencies |