Solaris Tutorials and Cookbook¶
There are two different ways to use
The command line interface (Simple use with existing models)
The Python API (Python users who wish to develop their own models)
Here we provide a brief introduction to these two approaches, links to tutorials, and usage recipes to complete common tasks. If there’s a common use case not covered here, submit an issue on the GitHub repo to request its inclusion.
The command line interface¶
The command line interface (CLI) is the simplest way to use Solaris. Using the CLI, you can run training and/or prediction on overhead imagery using SpaceNet models without writing a single line of python code.
After installing Solaris, you can run simple commands from a
terminal or command prompt for standard operations, from creating training masks
using vector labels to running an entire deep learning pipeline through
evaluating model performance. Instead of having to write code to help
find your data, you just make basic edits to a configuration file template, then
solaris does all the work to make your analysis pipeline fit together. Tutorials
on creating configuration files and running the CLI can be found below.
Evaluating prediction quality on SpaceNet data with the solaris CLI
If these relatively narrow use cases don’t cover your needs, the
API can help!
The Python API¶
solaris Python API provides every functionality needed to perform deep learning
analysis of overhead imagery data:
Customizable imagery and vector label tiling, with different size and coordinate system options.
Training mask creation functions, with the option to create custom width edge masks, building footprint masks, road network masks, multi-class masks, and even masks which label narrow spaces between objects.
All required deep learning functionality, from augmentation (including >3 channel imagery tools!) to data ingestion to model training and inference to evaluation during training. These functions are currently implemented with both PyTorch and TensorFlow backends.
The ability to use pre-trained or freshly initialized SpaceNet models, as well as your own custom models
Model performance evaluation tools for the SpaceNet IoU metric (APLS coming soon!)
The Python API Reference provides full documentation of everything described above and more. For usage examples to get you started, see the tutorials below.
Scoring your model’s performance with the solaris Python API
Check back here and follow us on Twitter or on our blog, The DownlinQ for updates!