diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..bf856a5 --- /dev/null +++ b/.npmignore @@ -0,0 +1,40 @@ +src/worker/tmp +.env +*.swp +*.swo +**.sass-cache +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git +node_modules +tmp/ +test-tmp/ +blob-local-storage/ +src/seeds/nn/hash.txt +src/seeds/pipeline/hash.txt + +# docs +images/ diff --git a/README.md b/README.md index 1675367..66a35ba 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,20 @@ **Notice**: DeepForge is still a work in progress and in beta! That being said, any contributions and/or feedback is greatly appreciated. If you have any questions, check out the [wiki](https://github.com/dfst/deepforge/wiki/) or drop me a line on the gitter! + # DeepForge -DeepForge is an open-source visual development environment for deep learning. Currently, it supports Convolutional Neural Networks, RNNs and LSTMs as well as the creation of custom layers. Additional features include: +DeepForge is an open-source visual development environment for deep learning providing end-to-end support for creating deep learning models. This is achieved through providing the ability to design **architectures**, create training **pipelines**, and then execute these pipelines over a cluster. Using a notebook-esque api, users can get real-time feedback about the status of any of their **executions** including compare them side-by-side in real-time. + +![overview](images/overview.png "") + +Additional features include: - Graphical architecture editor - Training/testing pipeline creation - Distributed pipeline execution - Real-time pipeline feedback - Collaborative editing - Automatic version control. +- Facilitates defining custom layers ## Quick Start Simply run the following command to install deepforge with its dependencies: diff --git a/images/overview.png b/images/overview.png new file mode 100644 index 0000000..6f0d79a Binary files /dev/null and b/images/overview.png differ