v0.3.0

Changes

Command Line Interface (CLI)

• New & Changed Commands
  • sapsan create --name {name} or sapsan create -n {name} - creates a custom project template tree
  • sapsan test - runs pytest to make sure Sapsan is working correctly
  • sapsan get_examples - copies Sapsan's examples into the current working directory for easy access
  • sapsan --version - to check the installed version
• Updated CLI options and --help

Testing

• moved tests to Sapsan's root folder, so they are always accessible when installed via pip
• notebook tests don't create a separate folder, but test on the existing example notebooks
• sapsan test allows for the user to run pytest tests to check if everything was installed correctly

Custom Estimators

• To get started, run: sapsan create -n {name}
  • where {name} should be replaced with your custom project name
• Significantly simplified the template structure, making it much easier to navigate and get started
  • cleaned up by removing all unnecessary templates, leaving a few scripts that allow to customize the estimator (i.e. ML network), Jupyter Notebook interface, and Dockerfile to easily share your project
  • pre-filled all templates with the custom project name

Examples

• sapsan get_examples: copies examples into ./sapsan_examples
  • makes the example jupyter notebooks with various ML algorithms easily accessible

Other

• sapsan now has __version__ attribute
• Updated the following sections in Documentation to reflect the CLI and template changes
  • Installation
  • Getting Started
  • Custom Estimators
  • Custom Docker
• Minor comment updates to example notebooks