Syberia

Syberia is the development framework for R.

Syberia was developed at Avant to
serve as the framework for developing and deploying machine learning models.
The goal was to develop a modeling engine capable of solving academic,
research and business problems that require use of statistical methods.

The modeling grammar,
currently the main significant engine built in Syberia, is a
framework for building, debugging, testing, and deploying classifiers developed in R.
It provides an opinionated unified framework for fast iteration on model development and deployment. It has modularity and testability built in
as a design assumption, is founded on convention-over-configuration,
and aims to solve the problems of classifier-specific data preparation and
classifier-specific modeling parameters.

The more general vision for Syberia is still in progress but aims
to bring unity to the currently disparate realms of the R development ecosystem.
In the viewpoint of the author, R is syntactic sugar around LISP, which enables arbitrary computation;
Syberia is an attempt to support this conjecture by allowing the
construction of arbitrary software projects within the R programming language,
thereby finally outgrowing its long-overdue misconception as a statistical tool.

The timeline for future engines and information about how
to contribute is listed at the Syberia roadmap.

Installation

To get started right away, try out the minimal
example syberia project:

# Run this from your command line terminal.
git clone [email protected]:syberia/example.sy.git && cd example.sy && R

This will open an R console (installing dependencies for the first time may take a while;
for troubleshooting see the troubleshooting guide).
You can then type:

run("example1")
model$predict(iris[1:5, ]) # The first five scores from a trained classifier.
# [1] 5.005686 4.757667 4.773923 4.890092 5.055138

For more detailed instructions, see the installation guide.

(Example generated using ttygif.)

Packages

Syberia relies on the following supplemental packages:

Name	Status
Mungebits2
Stagerunner
Tundra
Director

Additional packages used internally at Avant
in conjunction with Syberia modeling projects include
batchman,
bettertrace,
cachemeifyoucan,
dokk,
lockbox,
microserver,
objectdiff,
Ramd,
rocco,
s3mpi,
testthatsomemore, and
treeskeleton.

Engines

Syberia is currently released with the following engines.

Name	Status	Description
Base		The base engine that defines routes and controllers.
Modeling		The modeling engine for deploying structured learning problems.
Example		The hello world of modeling projects. Can be used for new projects.
Examples		Some examples from Kaggle and other sources in Syberia.

Development

To run the tests for the Syberia package, you will have to check
out its git submodules.

git submodule update --init --recursive

This will pull in inst/engines/base.sy from the base engine.

License

This project is licensed under the MIT License:

Copyright © 2014-2017 Robert Krzyzanowski

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
“Software”), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors

Syberia was originally created at Avant
by Robert Krzyzanowski, [email protected]. Additional contributors
include Peter Hurford, Kirill Sevastyanenko, Tong Lu, Abel Castillo, and others.