Add dokka and docs dir

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-We would be happy to have more volunterers for the android worker. This library constitutes and important component of on-device machine learning and you will be a part of this huge community
+We would be happy to have more volunteers for the Android worker. This library constitutes and important component of on-device machine learning and you will be a part of this huge community
 You can always join us on slack if you find an issue in which you are interested.
 
 Here are some important resources:

build.gradle

@@ -14,6 +14,7 @@ buildscript {
         classpath ProjectDependencies.netflixReleasePlugin
         classpath ProjectDependencies.netflixBintrayPlugin
         classpath ProjectDependencies.jacoco
+        classpath ProjectDependencies.dokka
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

buildSrc/src/main/java/Dependencies.kt

@@ -38,6 +38,7 @@ object Versions {
     const val netflixRelease = "13.0.0"
     const val netflixBintray = "3.5.4"
     const val jacocoVersion = "0.8.2"
+    const val dokkaVersion = "0.10.1"
 
     // Test
     const val extJunit = "1.1.1"
@@ -58,13 +59,11 @@ object ProjectDependencies {
     const val androidGradlePlugin = "com.android.tools.build:gradle:${Versions.gradle}"
     const val kotlinGradlePlugin = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.kotlin}"
     const val kotlinSerialization = "org.jetbrains.kotlin:kotlin-serialization:${Versions.kotlin}"
-    const val netflixPublishingPlugin = "com.netflix.nebula:nebula-publishing-plugin:" +
-                                        Versions.netflixPublishing
-    const val netflixReleasePlugin = "com.netflix.nebula:nebula-release-plugin:" +
-                                     Versions.netflixRelease
-    const val netflixBintrayPlugin = "com.netflix.nebula:nebula-bintray-plugin:" +
-                                     Versions.netflixBintray
-    const val jacoco = "org.jacoco:org.jacoco.core:" + Versions.jacocoVersion
+    const val netflixPublishingPlugin = "com.netflix.nebula:nebula-publishing-plugin:${Versions.netflixPublishing}"
+    const val netflixReleasePlugin = "com.netflix.nebula:nebula-release-plugin:${Versions.netflixRelease}"
+    const val netflixBintrayPlugin = "com.netflix.nebula:nebula-bintray-plugin:${Versions.netflixBintray}"
+    const val jacoco = "org.jacoco:org.jacoco.core:${Versions.jacocoVersion}"
+    const val dokka = "org.jetbrains.dokka:dokka-gradle-plugin:${Versions.dokkaVersion}"
 }
 
 object CommonDependencies {

docs/syftlib/alltypes/index.md

@@ -0,0 +1,99 @@
+
+
+### All Types
+
+| Name | Summary |
+|---|---|
+|
+
+##### [org.openmined.syft.networking.datamodels.ClientConfig](../org.openmined.syft.networking.datamodels/-client-config/index.md)
+
+
+|
+
+##### [org.openmined.syft.domain.DownloadStatus](../org.openmined.syft.domain/-download-status/index.md)
+
+
+|
+
+##### [org.openmined.syft.execution.JobStatusSubscriber](../org.openmined.syft.execution/-job-status-subscriber/index.md)
+
+This is passed as argument to [SyftJob.start](../org.openmined.syft.execution/-syft-job/start.md) giving the overridden callbacks for different phases of the job cycle.
+
+
+|
+
+##### [org.openmined.syft.proto.Placeholder](../org.openmined.syft.proto/-placeholder/index.md)
+
+
+|
+
+##### [org.openmined.syft.execution.Plan](../org.openmined.syft.execution/-plan/index.md)
+
+The Plan Class contains functions to load a PyTorch model from a TorchScript and
+to run training through the forward function of the PyTorch Module.
+A PyTorch Module is simply a container that takes in tensors as input and returns
+tensor after doing some computation.
+
+
+|
+
+##### [org.openmined.syft.threading.ProcessSchedulers](../org.openmined.syft.threading/-process-schedulers/index.md)
+
+
+|
+
+##### [org.openmined.syft.execution.Protocol](../org.openmined.syft.execution/-protocol/index.md)
+
+
+| (extensions in package org.openmined.syft.proto)
+
+##### [org.openmined.syftproto.execution.v1.StateOuterClass.State](../org.openmined.syft.proto/org.openmined.syftproto.execution.v1.-state-outer-class.-state/index.md)
+
+
+|
+
+##### [org.openmined.syft.Syft](../org.openmined.syft/-syft/index.md)
+
+
+|
+
+##### [org.openmined.syft.domain.SyftConfiguration](../org.openmined.syft.domain/-syft-configuration/index.md)
+
+
+|
+
+##### [org.openmined.syft.execution.SyftJob](../org.openmined.syft.execution/-syft-job/index.md)
+
+
+|
+
+##### [org.openmined.syft.proto.SyftModel](../org.openmined.syft.proto/-syft-model/index.md)
+
+SyftModel is the data model class for storing the weights of the neural network used for
+training or inference.
+
+
+|
+
+##### [org.openmined.syft.proto.SyftState](../org.openmined.syft.proto/-syft-state/index.md)
+
+SyftState class is responsible for storing all the weights of the neural network.
+We update these model weights after every plan.execute
+
+
+|
+
+##### [org.openmined.syft.proto.SyftTensor](../org.openmined.syft.proto/-syft-tensor/index.md)
+
+
+| (extensions in package org.openmined.syft.proto)
+
+##### [org.pytorch.Tensor](../org.openmined.syft.proto/org.pytorch.-tensor/index.md)
+
+
+| (extensions in package org.openmined.syft.proto)
+
+##### [org.openmined.syftproto.types.torch.v1.Tensor.TorchTensor](../org.openmined.syft.proto/org.openmined.syftproto.types.torch.v1.-tensor.-torch-tensor/index.md)
+
+

docs/syftlib/index.md

@@ -0,0 +1,16 @@
+[syftlib](./index.md)
+
+### Packages
+
+| Name | Summary |
+|---|---|
+| [org.openmined.syft](org.openmined.syft/index.md) |  |
+| [org.openmined.syft.domain](org.openmined.syft.domain/index.md) |  |
+| [org.openmined.syft.execution](org.openmined.syft.execution/index.md) |  |
+| [org.openmined.syft.networking.datamodels](org.openmined.syft.networking.datamodels/index.md) |  |
+| [org.openmined.syft.proto](org.openmined.syft.proto/index.md) |  |
+| [org.openmined.syft.threading](org.openmined.syft.threading/index.md) |  |
+
+### Index
+
+[All Types](alltypes/index.md)

docs/syftlib/org.openmined.syft.domain/-download-status/-c-o-m-p-l-e-t-e.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [DownloadStatus](index.md) / [COMPLETE](./-c-o-m-p-l-e-t-e.md)
+
+# COMPLETE
+
+`COMPLETE`

docs/syftlib/org.openmined.syft.domain/-download-status/-n-o-t_-s-t-a-r-t-e-d.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [DownloadStatus](index.md) / [NOT_STARTED](./-n-o-t_-s-t-a-r-t-e-d.md)
+
+# NOT_STARTED
+
+`NOT_STARTED`

docs/syftlib/org.openmined.syft.domain/-download-status/-r-u-n-n-i-n-g.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [DownloadStatus](index.md) / [RUNNING](./-r-u-n-n-i-n-g.md)
+
+# RUNNING
+
+`RUNNING`

docs/syftlib/org.openmined.syft.domain/-download-status/index.md

@@ -0,0 +1,13 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [DownloadStatus](./index.md)
+
+# DownloadStatus
+
+`enum class DownloadStatus`
+
+### Enum Values
+
+| Name | Summary |
+|---|---|
+| [NOT_STARTED](-n-o-t_-s-t-a-r-t-e-d.md) |  |
+| [RUNNING](-r-u-n-n-i-n-g.md) |  |
+| [COMPLETE](-c-o-m-p-l-e-t-e.md) |  |

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-networking-clients/-h-t-t-p.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [NetworkingClients](index.md) / [HTTP](./-h-t-t-p.md)
+
+# HTTP
+
+`HTTP`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-networking-clients/-s-o-c-k-e-t.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [NetworkingClients](index.md) / [SOCKET](./-s-o-c-k-e-t.md)
+
+# SOCKET
+
+`SOCKET`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-networking-clients/index.md

@@ -0,0 +1,12 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [NetworkingClients](./index.md)
+
+# NetworkingClients
+
+`enum class NetworkingClients`
+
+### Enum Values
+
+| Name | Summary |
+|---|---|
+| [HTTP](-h-t-t-p.md) |  |
+| [SOCKET](-s-o-c-k-e-t.md) |  |

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/-init-.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [<init>](./-init-.md)
+
+# <init>
+
+`SyftConfigBuilder(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, baseUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/build.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [build](./build.md)
+
+# build
+
+`fun build(): `[`SyftConfiguration`](../index.md)

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/disable-background-service-execution.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [disableBackgroundServiceExecution](./disable-background-service-execution.md)
+
+# disableBackgroundServiceExecution
+
+`fun disableBackgroundServiceExecution(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/disable-battery-check.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [disableBatteryCheck](./disable-battery-check.md)
+
+# disableBatteryCheck
+
+`fun disableBatteryCheck(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/enable-background-service-execution.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [enableBackgroundServiceExecution](./enable-background-service-execution.md)
+
+# enableBackgroundServiceExecution
+
+`fun enableBackgroundServiceExecution(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/enable-battery-check.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [enableBatteryCheck](./enable-battery-check.md)
+
+# enableBatteryCheck
+
+`fun enableBatteryCheck(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/enable-cellular-data.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [enableCellularData](./enable-cellular-data.md)
+
+# enableCellularData
+
+`fun enableCellularData(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/enable-metered-data.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [enableMeteredData](./enable-metered-data.md)
+
+# enableMeteredData
+
+`fun enableMeteredData(): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/index.md

@@ -0,0 +1,28 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](./index.md)
+
+# SyftConfigBuilder
+
+`class SyftConfigBuilder`
+
+### Constructors
+
+| Name | Summary |
+|---|---|
+| [<init>](-init-.md) | `SyftConfigBuilder(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, baseUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` |
+
+### Functions
+
+| Name | Summary |
+|---|---|
+| [build](build.md) | `fun build(): `[`SyftConfiguration`](../index.md) |
+| [disableBackgroundServiceExecution](disable-background-service-execution.md) | `fun disableBackgroundServiceExecution(): SyftConfigBuilder` |
+| [disableBatteryCheck](disable-battery-check.md) | `fun disableBatteryCheck(): SyftConfigBuilder` |
+| [enableBackgroundServiceExecution](enable-background-service-execution.md) | `fun enableBackgroundServiceExecution(): SyftConfigBuilder` |
+| [enableBatteryCheck](enable-battery-check.md) | `fun enableBatteryCheck(): SyftConfigBuilder` |
+| [enableCellularData](enable-cellular-data.md) | `fun enableCellularData(): SyftConfigBuilder` |
+| [enableMeteredData](enable-metered-data.md) | `fun enableMeteredData(): SyftConfigBuilder` |
+| [setCacheTimeout](set-cache-timeout.md) | `fun setCacheTimeout(timeout: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): SyftConfigBuilder` |
+| [setComputeScheduler](set-compute-scheduler.md) | `fun setComputeScheduler(computeSchedulers: `[`ProcessSchedulers`](../../../org.openmined.syft.threading/-process-schedulers/index.md)`): SyftConfigBuilder` |
+| [setFilesDir](set-files-dir.md) | `fun setFilesDir(filesDir: `[`File`](https://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): SyftConfigBuilder` |
+| [setMaxConcurrentJobs](set-max-concurrent-jobs.md) | `fun setMaxConcurrentJobs(numJobs: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): SyftConfigBuilder` |
+| [setNetworkingScheduler](set-networking-scheduler.md) | `fun setNetworkingScheduler(scheduler: `[`ProcessSchedulers`](../../../org.openmined.syft.threading/-process-schedulers/index.md)`): SyftConfigBuilder` |

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/set-cache-timeout.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [setCacheTimeout](./set-cache-timeout.md)
+
+# setCacheTimeout
+
+`fun setCacheTimeout(timeout: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/set-compute-scheduler.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [setComputeScheduler](./set-compute-scheduler.md)
+
+# setComputeScheduler
+
+`fun setComputeScheduler(computeSchedulers: `[`ProcessSchedulers`](../../../org.openmined.syft.threading/-process-schedulers/index.md)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/set-files-dir.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [setFilesDir](./set-files-dir.md)
+
+# setFilesDir
+
+`fun setFilesDir(filesDir: `[`File`](https://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/set-max-concurrent-jobs.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [setMaxConcurrentJobs](./set-max-concurrent-jobs.md)
+
+# setMaxConcurrentJobs
+
+`fun setMaxConcurrentJobs(numJobs: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/-syft-config-builder/set-networking-scheduler.md

@@ -0,0 +1,5 @@
+[syftlib](../../../index.md) / [org.openmined.syft.domain](../../index.md) / [SyftConfiguration](../index.md) / [SyftConfigBuilder](index.md) / [setNetworkingScheduler](./set-networking-scheduler.md)
+
+# setNetworkingScheduler
+
+`fun setNetworkingScheduler(scheduler: `[`ProcessSchedulers`](../../../org.openmined.syft.threading/-process-schedulers/index.md)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/battery-check-enabled.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [batteryCheckEnabled](./battery-check-enabled.md)
+
+# batteryCheckEnabled
+
+`val batteryCheckEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

docs/syftlib/org.openmined.syft.domain/-syft-configuration/builder.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [builder](./builder.md)
+
+# builder
+
+`fun builder(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, baseUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): SyftConfigBuilder`

docs/syftlib/org.openmined.syft.domain/-syft-configuration/cache-time-out.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [cacheTimeOut](./cache-time-out.md)
+
+# cacheTimeOut
+
+`val cacheTimeOut: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)

docs/syftlib/org.openmined.syft.domain/-syft-configuration/compute-schedulers.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [computeSchedulers](./compute-schedulers.md)
+
+# computeSchedulers
+
+`val computeSchedulers: `[`ProcessSchedulers`](../../org.openmined.syft.threading/-process-schedulers/index.md)

docs/syftlib/org.openmined.syft.domain/-syft-configuration/context.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [context](./context.md)
+
+# context
+
+`val context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)

docs/syftlib/org.openmined.syft.domain/-syft-configuration/files-dir.md

@@ -0,0 +1,5 @@
+[syftlib](../../index.md) / [org.openmined.syft.domain](../index.md) / [SyftConfiguration](index.md) / [filesDir](./files-dir.md)
+
+# filesDir
+
+`val filesDir: `[`File`](https://docs.oracle.com/javase/6/docs/api/java/io/File.html)