Skip to content
Snippets Groups Projects
README.md 575 B
Newer Older
='s avatar
= committed
TODO: Update this file
# Use model without installation
For developing
='s avatar
= committed
```cd src```
='s avatar
= committed
## primary workflows
='s avatar
= committed
### Train model
='s avatar
= committed
### Optimize hyperparameters
='s avatar
= committed
### Predict a new observation
='s avatar
= committed
# Use model as a package
='s avatar
= committed
## Virtual environment (optional)
```
python3 -m venv venv
source venv/bin/activate
```
Ryan Christopher Godwin's avatar
Ryan Christopher Godwin committed

## Installation
='s avatar
= committed
From the src/ directory...
='s avatar
= committed
```
python3 -m pip install pip setuptools wheel
python3 -m pip install -e .
```
='s avatar
= committed
If you are developing this package, 
```
python3 -m pip install pip setuptools wheel
python3 -m pip install -e ".[dev]"
```
='s avatar
= committed
## Primary workflows