Improve readme

Author: Sopamo

Readme.md

@@ -12,17 +12,24 @@ High performance, state of the art machine learning in php.
 
 If you have a usecase that's not listed above, please create an [issue](https://github.com/funcai/funcai-php/issues/new) and explain what you would like to do.
 
-### Features
+## Features
 
  - **Runs everywhere** - You only need PHP, **nothing else**
  - **Super simple API** - No machine learning knowledge required
  - **Maximum performance** - Preloads the machine learning core, so predictions are super fast
 
-### Installation
-Install the package via composer:
+## Installation
+#### 1. Install the package via composer:
 
     composer require funcai/funcai-php
 
+#### 2. Download the tensorflow library:
+
+    php vendor/funcai/funcai-php/install.php
+
+This downloads tensorflow to `./tensorflow`.
+
+#### 3. Download the required models
 Until we've figured out a solution for how to host the final models, the following step is a bit more difficult than we'd like it to be.
 
 You'll need to have python installed (locally), and some sort of way to host the model files yourself.
@@ -32,27 +39,39 @@ To generate the model, run:
     pip3 install tensorflow
     python3 vendor/funcai/funcai-php/scripts/generate/efficientnet.py
 
-The model will be placed in vendor/funcai/funcai-php/models/efficientnet. You will need to have access to this folder from your webserver. For example, if you've uploaded the folder to /var/www/models/efficientnet, you should set the path like this:
+The model will be placed in vendor/funcai/funcai-php/models.
+
+#### 4. Configure the models folder
+You will need to move the models folder to a permanent location.
+For example, move it to `/var/www/models` on your server. In that case make sure to set the base path accordingly:
 
     \FuncAI\Config::setModelBasePath('/var/www/models');
 
+You can also just move the folder directly into your project and check them into git, but the folder might get quite big (100 Mb up to multiple Gb).
 
-### Requirements
- - Either the provided dockerfile
- - Or PHP >= 7.4 on Linux
+## Usage
+After you've completed the installation steps you can run your first prediction:
 
-### Run with docker
+    \FuncAI\Config::setLibPath('./tensorflow/'); // This should point to the path from step 2 
+    $model = new \FuncAI\Models\EfficientNet();
+    $output = $model->predict('./vendor/funcai/funcai-php/sample_data/butterfly.jpg');
 
- - Run `docker-compose up -d`
- - Run `docker-compose exec app bash`
- - Run `php example.php`
+## Requirements
+ - PHP >= 7.4 on Linux
+ - Or use the provided Dockerfile
 
 ### About machine learning
 todo
- - Pick the correct tasks (easy for computer, hard / repetitive for humans)
- - Training bias dilemma
- - Uncertainty
- - Specific tasks
+- Pick the correct tasks (easy for computer, hard / repetitive for humans)
+- Training bias dilemma
+- Uncertainty
+- Specific tasks
+
+### How to run the docker file
+
+ - Run `docker-compose up -d`
+ - Run `docker-compose exec app bash`
+ - Run `php example.php`
 
 ### Architecture
 
@@ -68,14 +87,14 @@ todo
 ### Development
 
 #### Docker (optional, but recommended)
-Install [Docker](https://docs.docker.com/get-docker/) if you do not have it already.
+Install [Docker](https://docs.docker.com/get-docker/).
 
 #### Download the efficientnet model
 To be able to run the example file you need to run the following docker command which will download the efficientnet model and save it in the correct file format:
 
     docker run -it --rm -v $PWD:/code -w /code tensorflow/tensorflow:2.3.0 python scripts/generate/efficientnet.py
 
-Alternatively, if you already have python3 installed you can run:
+Alternatively, if you already have python3 installed you can just run:
 
     pip3 install tensorflow
     python3 scripts/generate/efficientnet.py
@@ -89,7 +108,9 @@ Afterwards run:
 
     docker-compose exec app bash
 
-to get a Terminal inside of the docker container
+to get a Terminal inside of the docker container.
+
+Alternatively you can just setup a PHP 7.4 environment locally and use that.
 
 #### Better phpstorm support (optional)
 Go to your settings and open "Languages & Frameworks -> PHP -> PHP Runtime -> Others". Make sure "FFI" is checked. 

install.php

@@ -0,0 +1,8 @@
+<?php
+require __DIR__.'/vendor/autoload.php';
+
+// Specify where tensorflow should be downloaded to
+\FuncAI\Config::setLibPath('./tensorflow/');
+
+$tfi = new \FuncAI\Install\TensorflowInstaller();
+$tfi->install();