frenchja commented 7 years ago

Overview

@robertzk @peterhurford

We can't guarantee that anyone that stumbles upon syberia/examples will have seen the docs or be following the docs. I propose adding a Get Started in 2 Minutes example using Titanic to the documentation.

In addition, should we edit the Prereqs to include less detail about Syberia's components and instead focus on a quick explanation of lockbox and installation?

Last, adding links to concrete file examples to the Structure may help enhance the clarity of that section and highlight the expected difference between an initializer and an application configuration.

Tasks

[ ] Relink Syberia to main page instead of Github code in https://github.com/syberia/examples#about-syberia
[ ] Add file links to https://github.com/syberia/examples#structure
[ ] Rewrite prerequisites to focus on quick installation for new users
[ ] Add Get Started in 2 Minutes section to main README

kirillseva commented 7 years ago

maybe a screencast that demonstrates how to train your first model in 5 minutes? or an asciinema

robertzk commented 7 years ago

I agree on all points. Let's get to this next hackathon.

syberia / examples

Rewrite project README #12

Overview

Tasks