Documentation improvements (#319)

* WIP

* WIP

* WIP

* WIP

* Adds preview

* [add] updated performance section with diagrams and some rephrasing

* [add] added configuration info regarding INTRA_OP_PARALLELISM and INTER_OP_PARALLELISM

* [add] added AI.DAGRUN documentation

* [wip] kicked off examples page

* [wip] kicked off examples page

* [wip] wip on documentation

* [wip] wip on documentation

* [wip] chaning example image location

* [wip] experimenting with image positioning on examples

* [fix] correcting classified image path

* [fix] fixed example image path

* [fix] fixed TBD on scriptrun example

* ASCII-fies diagram

* ASCII-fies diagram

* Dang the diagram

* Diagram again

* [add] kick-off the developer notes page

* [wip] kick-off developer page. reference dlpack on documentation

* [add] added Developer reference link

* [wip] added main source files to document

* [wip] improved code documentation of dag.h/c err.h/c and tensor.h/c

* [wip] improved further code documentation on tensor.h

* [wip] added backends.h and backends directory developer info. pushing forward on developer.md information

* [add] updated model.h/c with the documentation of each method

* [wip] added further documentation on the src/background_workers.h/.c files. wip on coverage fix

* [wip] wip on coverage fix

* [wip] added documentation to the stats.h/c and script.h/c files. Ran a spelling on src/* and docs/*

* [fix] removed repeating ai.tensorget from dag's documentation

* [wip] fixed formatting issues on developer.md

* [fix] fixed documentation on ai.tensorget

* [wip] finished code comment all methods on the major building blocks of RedisAI

* Adds contrib.md

* [add] documentation revision for RC - iteration 1

* [fix] updated developer notes

* [fix] fixed the quickstart commands and made reference to #developer

* Tweeks pt. 1

* [fix] fix performance diagram links

* Tweaks pt.2

* Corrects to `MODULE LOAD`

ht @DvirDukhan

* Adds versioned docs and deploys docs from a GitHub Action

Co-authored-by: filipecosta90 <filipecosta.90@gmail.com>

Author: itamarhaber

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 commands:
-  ci_steps:
+  setup_steps:
     parameters:
       platform:
         type: string
@@ -27,6 +27,13 @@ commands:
           command: |
             mkdir -p ~/workspace
             chown `whoami` ~/workspace
+
+  test_steps:
+    parameters:
+      platform:
+        type: string
+    steps:
+      - checkout
       - run:
           name: Build
           command: make -C opt all SHOW=1
@@ -48,7 +55,7 @@ commands:
             - 'packages/branch/*.tgz'
       - store_artifacts:
           path: test/logs
-          
+
   deploy:
     parameters:
       from:
@@ -64,7 +71,9 @@ jobs:
     docker:
       - image: redisfab/rmbuilder:5.0.7-x64-buster
     steps:
-      - ci_steps:
+      - setup_steps:
+          platform: debian
+      - test_steps:
           platform: debian
 
   coverage:
@@ -89,7 +98,7 @@ jobs:
             mkdir -p ~/workspace
             chown `whoami` ~/workspace
       - run:
-          name: Build
+          name: Build for coverage
           command: |
             make -C opt all COV=1 SHOW=1
       - run:
@@ -107,7 +116,9 @@ jobs:
           name: Fix macOS Python installation
           command: |
             brew reinstall -f python2
-      - ci_steps:
+      - setup_steps:
+          platform: macosx
+      - test_steps:
           platform: macosx
 
   build-multiarch-docker:
@@ -170,19 +181,6 @@ jobs:
       - store_artifacts:
           path: ~/workspace/packages/<<parameters.package>>
 
-  deploy_docs:
-    docker:
-      - image: redisfab/rmbuilder:5.0.7-x64-buster
-    steps:
-      - checkout
-      - run:
-          name: Build Docs
-          command: python3 -m mkdocs build
-      - run:
-          name: Deploy Docs to S3
-          command: |
-            aws s3 cp site s3://oss.redislabs.com/$WEBSITE_FOLDER/ --acl public-read --recursive
-
 workflows:
   version: 2
   build_and_package:
@@ -196,7 +194,7 @@ workflows:
             branches:
               only: /.*/
             tags:
-              only: /.*/ 
+              only: /.*/
       # - build-macos:
       #     filters:
       #       branches:
@@ -206,7 +204,7 @@ workflows:
       #- build-multiarch-docker:
       #    filters:
       #      tags:
-      #        only: /^v[0-9].*/ 
+      #        only: /^v[0-9].*/
       #      branches:
       #        ignore: /.*/
       - build-gpu:
@@ -231,10 +229,6 @@ workflows:
               ignore: /.*/
             tags:
               only: '/^v[0-9].*/'
-      - deploy_docs:
-          filters:
-            branches:
-              only: master
 
   #nightly:
   #  triggers:

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,36 @@
+name: Deploy docs to website
+
+on:
+  push:
+    branches:
+      - master
+      - '[0-9]+.[0-9]+'
+    paths:
+      - 'mkdocs.yml'
+      - 'docs/**'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+    - name: Install docs dependencies
+      run: pip install -r docs/requirements.txt
+    - name: Build docs
+      run: mkdocs build
+    - uses: jakejarvis/s3-sync-action@master
+      with:
+        args: --acl public-read --follow-symlinks --delete
+      env:
+        AWS_S3_ENDPOINT: ${{ secrets.DOCS_AWS_S3_ENDPOINT }}
+        AWS_S3_BUCKET: ${{ secrets.DOCS_AWS_S3_BUCKET }}
+        AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }}
+        SOURCE_DIR: 'site'

.gitignore

@@ -5,6 +5,8 @@
 /test/venv/
 logs/
 /test/logs/
+.env/
+env*/
 .venv/
 venv*/
 /install
@@ -79,7 +81,7 @@ __pycache__
 
 # Debug/Profile files
 # ignore perf html reports
-*.html 
+*.html
 
 # Kernel Module Compile Results
 *.mod*
@@ -129,4 +131,7 @@ dkms.conf
 /out/
 
 # mpeltonen/sbt-idea plugin
-.idea_modules/
+.idea_modules/
+
+# docs site
+site/

docs/clients.md

@@ -0,0 +1,11 @@
+# RedisAI Clients
+
+Some languages already have client libraries that provide support for RedisAI's commands. The following table lists the known ones:
+
+| Project | Language | License | Author | URL |
+| ------- | -------- | ------- | ------ | --- |
+| JRedisAI | Java | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/JRedisAI) |
+| redisai-py | Python | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-py) |
+| redisai-go | Go | BSD-3 | [RedisLabs](https://redislabs.com/) | [Github](https://github.com/RedisAI/redisai-go) |
+
+The full documentation for RedisAI's API can be found at the [Commands page](commands.md).