Build Configuration File

You can control additional build options for your project by including a "gravityai-build.json" file in your uploaded archive. This file should be in standard json format. Be sure it's located at the root level of the project:

Project_to_Upload/
   |--> src/
   |--> gravityai-build.json

Example File

The following example installs tesseract as a dependency. It also offers an input file along with expected output to use as a test at build time.

{
  "SystemPackages": [
    "g++",
    "libleptonica-dev",
    "autoconf",
    "automake",
    "libtool",
    "pkg-config",
    "libpng-dev",
    "libjpeg62-turbo-dev",
    "libtiff5-dev",
    "zlib1g-dev",
    "tesseract-ocr"
  ],
  "Tests": [
    {
      "RelativeInputPath": "./OCR-Passage-Test-1.jpg",
      "RelativeReferencePath": "./OCR-Passage-Test-1.result.txt"
    },
    {
      "RelativeInputPath": "./OCR-Check-Test-1.jpg",
      "RelativeReferencePath": null
    }
  ]
}

SystemPackages Field

This is an array of string values, each the name of a linux system package. At the moment, these packages should be available on the debian linux distribution. The base container image is debian buster slim, so you may need to include additional packages not normally available on buster slim.

"SystemPackages": [
    "g++",
    "automake"
]

Tests Field

Tests is an array of Test Objects:

"Tests": [
    {
      "RelativeInputPath": "./OCR-Passage-Test-1.jpg",
      "RelativeReferencePath": "./OCR-Passage-Test-1.result.txt"
    },
    {
      "RelativeInputPath": "./OCR-Check-Test-1.jpg",
      "RelativeReferencePath": null
    }
]

Each Test object has the following fields:

• RelativeInputPath - A text string path to look at in the archive, relative to the directory location of this configuration file. The path should point to a test data input file that your algorithm will accept and run against at build time. If the output produced is structured data, then it is compared against the expected structure added to the build settings (ie. Schema Paths).

• RelativeReferencePath - A test string path to look at in the archive, relative to the directory location of this configuration file. The path should point to the expected output that your algorithm will product, given the above input file. The results of your algorithm are compared against this file (a byte-wise comparison). If the result is identicle to this file, the test passes. Otherwise the build fails. This filed may be set to null or omitted altogether. This results in the output being verified that it exists, but it is not compared against a file. Note that the byte-wise comparison can fail due to character encoding and line-ending difference between linux and the operative system you produce the original file on.

Example 2 File

The following example uses the gravityAI library and the Schema item to automatically populate the settings during the container upload process.

{
  "UseGaiLib": true,
  "Tests": [
    {
      "RelativeInputPath": "test_data.csv",
      "RelativeReferencePath": "test_reference.csv"
    }
  ],
  "Schema": {
    "InputType": "csv_header",
    "OutputType": "csv_header",
    "Input": [
      {
        "DataType": "Number",
        "Optional": false, 
        "Path": "x"
      },
      {
        "DataType": "Number",
        "Optional": false,
        "Path": "y"
      }
    ],
    "Output": [
      {
        "DataType": "Number",
        "Optional": false,
        "Path": "x"
      },
      {
        "DataType": "Number",
        "Optional": false,
        "Path": "y"
      },
      {
        "DataType": "Number",
        "Optional": false,
        "Path": "z"
      }
    ]
  }
}

UseGaiLib Field

Set this to true if you are using the gravityAI library. This is currently only available for python found here.

"UseGaiLib": true

Schema Field

Schema is an optional object that defines the input and output file types as well as their schema:

"Schema": {
    "InputType": "<mimetype>",
    "OutputType": "<mimetype>",
    "InputSchema": [
      {
        "DataType": "<datatype>",
        "Optional": false, 
        "Path": "<schemapath>"
      },
    ],
    "OutputSchema": [
      {
        "DataType": "<datatype>",
        "Optional": false, 
        "Path": "<schemapath>"
      },
    ]
}

Each Test object has the following fields:

• InputType & OutputType - "<mimetype>" is a text string corresponding to an item in the mimetype enummerated list in the container api, to indicate the type of file. This value can be one of types:

  • "json" - For use with a JavaScript Object Notation file.
  • "csv" - For use with a Comma Separated Value file.
  • "csv_header" - For use with a Comma Separated Value file with Headers.

• InputSchema & OutputSchema - An list which contains schema setting objects that will auto-populate the container upload form. The object must contain the following:

  • DataType - "<datatype>" is a text string corresponding to an item in the datatype enummerated list in the container api, to indicate the type of data the path represents. This value can be one of types:

    • "string"
    • "number"
    • "date"
    • "boolean"

  • Optional - A boolean value to indicate whether the path is optional.
  • Path - A schema path as defined in Schema Paths.