diff --git a/README.md b/README.md index 636b38d92..7b499b3cc 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in ### Setup Authentication for Docker Environment 1. Go to Github Developer Applications and create a new application. [here](https://github.com/settings/developers) -2. For local deployments,the following should be used in the options: +2. For local deployments, the following should be used in the options: * Application name: Fabrik * Homepage URL: http://0.0.0.0:8000 * Application description: Fabrik @@ -55,25 +55,25 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in 3. Github will provide you with a Client ID and a Secret Key. Save these. -4. Create a superuser in django service of docker container +4. Create a superuser in Django service of Docker container ``` - docker-compose run django python manage.py createsuperuser + docker-compose run Django python manage.py createsuperuser ``` - Note: Before creating the superuser, make sure that django service of docker image is running. This can be done by executing ``` docker-compose up ``` followed by ``` Ctrl + C ``` to save docker configuration. + Note: Before creating the superuser, make sure that Django service of docker image is running. This can be done by executing ``` docker-compose up ``` followed by ``` Ctrl + C ``` to save docker configuration. 5. Open http://0.0.0.0:8000/admin and login with the credentials from step 4. -6. Setting up Social Accounts in django admin +6. Setting up Social Accounts in Django admin * Under ``` Social Accounts ```, open ``` Social applications ``` and click on ``` Add Social Application ```. - * Choose the ``` Provider ``` of social application as ``` Github ``` and name it ``` Github ```. + * Choose the ``` Provider ``` of the social application as ``` Github ``` and name it ``` Github ```. - * Add the sites available to the right side, so github is allowed for the current site. + * Add the sites available to the right side, so GitHub is allowed for the current site. - * Copy and paste your ``` Client ID ``` and ``` Secret Key ``` into the apppropriate fields and Save. + * Copy and paste your ``` Client ID ``` and ``` Secret Key ``` into the appropriate fields and Save. 7. Go to ``` Sites ``` tab and update the ``` Domain name ``` to ``` 0.0.0.0:8000 ```. @@ -135,7 +135,7 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in 5. If you already have Caffe, Keras and TensorFlow installed on your computer, skip this step. * For Linux users - * Install Caffe, Keras and Tensorflow + * Install Caffe, Keras, and Tensorflow ``` cd Fabrik/requirements @@ -216,9 +216,9 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in celery -A ide worker --app=ide.celery_app --loglevel=info ``` - The celery worker needs to be run in parallel to the django server in a separate terminal. + The celery worker needs to be run in parallel to the Django server in a separate terminal. -10. Start django application +10. Start Django application ``` python manage.py runserver @@ -237,7 +237,7 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in 3. Github will provide you with a client ID and secret Key, save these. -4. Create a superuser in django +4. Create a superuser in Django ``` python manage.py createsuperuser @@ -253,17 +253,17 @@ To install Docker for Mac [click here](https://docs.docker.com/docker-for-mac/in 7. Login with the credentials from step 4. -8. Setting up Social Accounts in django admin : +8. Setting up Social Accounts in Django admin : * Under ```Social Accounts``` open ``` Social applications ```, click on ``` Add Social Application ```. - * Choose the ``` Provider ``` of social application as ``` Github ``` & name it ``` Github ```. + * Choose the ``` Provider ``` of the social application as ``` Github ``` & name it ``` Github ```. - * Add the sites available to the right side, so github is allowed for the current site. This should be `localhost:8000` for local deployment. + * Add the sites available to the right side, so GitHub is allowed for the current site. This should be `localhost:8000` for local deployment. * Copy and paste your ``` Client ID ``` and ``` Secret Key ``` into the appropriate fields and Save. -9. From the django admin home page, go to `Sites` under the `Sites` category and update ``` Domain name ``` to ``` localhost:8000 ```. +9. From the Django admin home page, go to `Sites` under the `Sites` category and update ``` Domain name ``` to ``` localhost:8000 ```. Note: For testing, you will only need one authentication backend. However, if you want to try out Google's authentication, then, you will need to follow the same steps as above, but switch out the Github for Google. diff --git a/docs/graphvis_research/README.md b/docs/graphvis_research/README.md index f80448195..9835f3e6b 100644 --- a/docs/graphvis_research/README.md +++ b/docs/graphvis_research/README.md @@ -1,15 +1,15 @@ # Research about adding support for exporting model graphs from Fabrik Attached code requires [common dependencies](../../requirements/common.txt), plus `networkx` and `pydot` Python packages. ## Problem -Currently there's no tools for drawing Fabrik neural network diagram directly, without need to do it by hand. This research observes some ways to implement such function. +Currently, there are no tools for drawing Fabrik neural network diagram directly, without the need to do it by hand. This research observes some ways to implement such function. ## Observations During research, I managed to found some ways. They even can be divided into two groups. ### Based on deep learning frameworks -These methods share the common weakness: they cannot draw unsupported layers. For example, Keras cannot draw LRN layer. Also they could be implemented in backend only. +These methods share the common weakness: they cannot draw unsupported layers. For example, Keras cannot draw LRN layer. Also, they could be implemented in backend only. -Note that all tools can implemented with algorithms of conversion Fabrik net to framework model directly, without creating model files. +Note that all tools can implement with algorithms of conversion Fabrik net to framework model directly, without creating model files. #### Keras -Keras have its own utilities, described in its [documentation](https://keras.io/visualization/). All methods are based on [Pydot](https://github.com/pydot/pydot) library, a Python interface of [Graphviz](http://graphviz.org/). One of the utilities is used in the `print_keras_model.py`. Below there is VQI model representation drawn by Keras. +Keras has its own utilities, described in its [documentation](https://keras.io/visualization/). All methods are based on [Pydot](https://github.com/pydot/pydot) library, a Python interface of [Graphviz](http://graphviz.org/). One of the utilities is used in the `print_keras_model.py`. Below there is VQI model representation drawn by Keras. ![](KerasVis.png) To get similar with this or other model type: @@ -26,19 +26,19 @@ python ~/caffe/caffe/python/draw_net.py ../../example/caffe/ -- Here is a whole layer shown named ```ReLU```. It is a ```Activation/Neuron Layer```, that's why it is kept below the line ```/* ********** Activation/Neron Layers ********** */```. -- Then add the suitable comment for you layer or leave it empty if it is not for any specific framework. +- Here is a whole layer shown named ```ReLU```. It is a ```Activation/Neuron Layer```, that's why it is kept below the line ```/* ********** Activation/Neuron Layers ********** */```. +- Then add the suitable comment for your layer or leave it empty if it is not for any specific framework. - Keywords' explanation: - name: Name of the layer. - - color: Color of the layer to be shown in frontend. + - color: Colour of the layer to be shown in the frontend. - endpoint: Endpoints of the layer. - src: Source endpoint of the layer. - trg: Target endpoint of the layer. - params: Parameters for the layer. - inplace: Checkbox input for the layer. - negative_slope: Numerical input for the layer. - - caffe: Availibility of caffe (Checkbox input). + - caffe: Availability of caffe (Checkbox input). - props: It defines the properties of the layer. - learn: This declares if the layer can be used for learning. - We can define different parameters for a layer and it is not limited to ```inplace``` & ```negative_slope```. @@ -60,7 +60,7 @@ - Add a function for the new layer below the category of this layer. -- Load the parameters, do the calculations for your layer in pyhton and return the value of ```params``` (parameters). +- Load the parameters, do the calculations for your layer in python and return the value of ```params``` (parameters). - Move down in the file. @@ -81,10 +81,10 @@ ### Testing and pushing the new layer. -- Run the fabrik application on you local machine by following the instructions in [README](https://github.com/Cloud-CV/Fabrik/blob/master/README.md) file. +- Run the fabrik application on your local machine by following the instructions in [README](https://github.com/Cloud-CV/Fabrik/blob/master/README.md) file. -- Check the new layer inside the category you added it. See if all the parameters are properly displayed and usable as you wanted. +- Check the new layer inside the category you added to. See if all the parameters are properly displayed and usable as you wanted. - If everything is working fine commit your changes and push it to your fork then make a Pull Request. -- Congratulations! Happy contributing :-) \ No newline at end of file +- Congratulations! Happy contributing :-) diff --git a/docs/source/addng_new_model.md b/docs/source/addng_new_model.md index 050a34101..cb2ee5ab0 100644 --- a/docs/source/addng_new_model.md +++ b/docs/source/addng_new_model.md @@ -9,22 +9,18 @@
  • Sample
  • ``` -4. After making these changes, test if loading the model and exporting it to both or at least one framework is working fine and document it accordingly in your pull request. -5. Add a thumbnail image for displaying a preview of the new model. -6. Add the new model to [Tested Models](https://github.com/Cloud-CV/Fabrik/blob/master/tutorials/tested_models.md). -7. Create a pull request for the same and get reviewed by the mentors. +4. After making these changes, test, if loading the model and exporting it to both or at least one framework, is working fine and document it accordingly in your pull request. +5. Create a pull request for the same and get reviewed by the mentors. Cheers! ### Adding New Model - Keras 1. For Setup instructions, look at the [README](https://github.com/Cloud-CV/Fabrik/blob/master/README.md). 2. Add the new model as a .json file to the [Example/Keras](https://github.com/Cloud-CV/Fabrik/tree/master/example/keras) folder. -3. Then add your entry to the front-end by refering to the following example in [modelZoo.js](https://github.com/Cloud-CV/Fabrik/blob/master/ide/static/js/modelZoo.js), in this the ```id``` should be the name of your json without the extension. +3. Then add your entry to the front-end by referring to the following example in [modelZoo.js](https://github.com/Cloud-CV/Fabrik/blob/master/ide/static/js/modelZoo.js), in this, the ```id``` should be the name of your json without the extension. ```
  • sample
  • ``` -4. After making these changes, test if loading the model and exporting it to both or at least one framework is working fine and document it accordingly in your pull request. -5. Add a thumbnail image for displaying a preview of the new model. -6. Add the new model to [Tested Models](https://github.com/Cloud-CV/Fabrik/blob/master/tutorials/tested_models.md). -7. Create a pull request for the same and get reviewed by the mentors. +4. After making these changes, test, if loading the model and exporting it to both or at least one framework, is working fine and document it accordingly in your pull request. +5. Create a pull request for the same and get reviewed by the mentors. Cheers! diff --git a/docs/source/caffe_prototxt_usage_1.md b/docs/source/caffe_prototxt_usage_1.md index 2504b0f64..e0640227d 100644 --- a/docs/source/caffe_prototxt_usage_1.md +++ b/docs/source/caffe_prototxt_usage_1.md @@ -2,7 +2,7 @@ In order to export a Caffe Model from Fabrik: -1. Select the 2nd button from the left in the Actions section of the sidebar. +1. Select the second button from the left in the Actions section of the sidebar. 2. A drop-down list should appear. Select Caffe. @@ -34,4 +34,4 @@ In order to export a Caffe Model from Fabrik: caffe train \ -gpu 0 \ -solver solver.prototxt - ``` \ No newline at end of file + ``` diff --git a/docs/source/caffe_prototxt_usage_2.md b/docs/source/caffe_prototxt_usage_2.md index 95f7073fb..578383b99 100644 --- a/docs/source/caffe_prototxt_usage_2.md +++ b/docs/source/caffe_prototxt_usage_2.md @@ -1,4 +1,4 @@ -## Use exported model in Caffe +## Use the exported model in Caffe ### To export the model for Caffe in Fabrik @@ -44,4 +44,4 @@ model_details(model) - Switch to the terminal we were using earlier. - Type ```python caffeLoader.py```. - Congrats! You should see the model's parameters and output sizes. -- You can further use the model for training/testing purpose. Read about it more [here](caffe_prototxt_usage_1.md). \ No newline at end of file +- You can further use the model for training/testing purpose. Read about it more [here](caffe_prototxt_usage_1.md). diff --git a/docs/source/keras_json_usage_1.md b/docs/source/keras_json_usage_1.md index c4a941e11..50449c97b 100644 --- a/docs/source/keras_json_usage_1.md +++ b/docs/source/keras_json_usage_1.md @@ -29,7 +29,7 @@ We want to export our model for Keras from Fabrik. ### Example[1](https://machinelearningmastery.com/save-load-keras-deep-learning-models/) 1. [Export](http://fabrik.cloudcv.org/caffe/load?id=20171207035101pfjnz) this example Keras model (name it ```model.json```). -2. [Download](http://archive.ics.uci.edu/ml/machine-learning-databases/pima-indians-diabetes/pima-indians-diabetes.data) this data set that we will use to train on (name it ```pima-indians-diabetes.csv```). +2. [Download](http://archive.ics.uci.edu/ml/machine-learning-databases/pima-indians-diabetes/pima-indians-diabetes.data) this dataset that we will use to train on (name it ```pima-indians-diabetes.csv```). 3. Create a python file (name it ```kerasJSONLoader.py```) and insert the following code: ``` @@ -72,4 +72,3 @@ We want to export our model for Keras from Fabrik. You should be getting around 76-78% accuracy. This code trains and evaluates the loaded model on the dataset. - diff --git a/docs/source/keras_json_usage_2.md b/docs/source/keras_json_usage_2.md index afcfee5e9..286d01e42 100644 --- a/docs/source/keras_json_usage_2.md +++ b/docs/source/keras_json_usage_2.md @@ -1,4 +1,4 @@ -## Use exported model in Keras +## Use the exported model in Keras ### To export the model for Keras in Fabrik