Creating a project

Creating a project on Codr.

Understanding the project schema

The underlining workings of the project schema is quite complex, but we try to make it as simple as possible to understand so that you can easily pick it up and use it to it's fullest potential.

Codr's dot notation tokens

Codr has a custom dot-notation systax that can be used in several parts of the project configuration. There are three tokens searched for within certian parameters, these are: $sample, $value, and $index. Each token is described below including what their purpose is, where to use it, and examples.

$sample

The $sample dot-notation token references the root of a dataset sample item. It can be used in a projects inputs.[*].value and outputs.[*].options.

Example:

const exampleInputOne = {
  type: 'text',
  // value is a string
  value: '$sample.value',
}

$value

The $value dot-notation token references the object that the inputs.[*].value string points to and can be used inside the inputs.[*].format string.

Example:

const exampleInputOne = {
  type: 'text',
  // items is an tuple
  value: '$sample.items',
  // this grabs the items in the tuple.
  format: 'Tuple value: $value.[0], $value.[1]',
}

const exampleInputTwo = {
  type: 'text',
  // object is defined as: { title: string, body: string }
  value: '$sample.object',
  // this grabs the title and body from the value and formats it to the screen.
  format: '### $value.title:\n\n$value.body',
}

$index

The $index dot-notation token references the array index of an item. It can be used inside inputs.[*].header

Example:

const exampleInputOne = {
  type: 'text',
  collapsible: true,
  // items is an array of string being displayed in collapsible components.
  value: '$sample.items.[*]',
  // $index is used to reference the item index for collapsible inputs.
  header: 'Item $index',
}

Configuration deep dive

General configuration

{
  "general": {
    "title": "project title",
    "slug": "/project-slug",
    "type": "labeling",
    "bgClassColor": "bg-pink-600",
    "guidelines": "Project \n Guidelines",
    "anonymize": false
  },
  ...
}

Display configuration

// Complete display example
{
  ...
  "display": {
    "inputs": [
      { "type": "text", "value": "Some text here" },
    ],
    "outputs": [
      { "type": "range", "range": [1, 10] },
    ],
  },
  ...
}

Inputs

Inputs can be very simple, but they can also be quite complex. Below you will find an example of a complex input element.

// Complex input example
{
  "type": "text",
  "value": "$sample.hops.[*]",
  "format": "```java\n$value\n```",
  "collapsible": true,
  "header": "Hop $index"
}

Sample configuration

As the name implies, the sample configuration allows you to configure how to handle your dataset samples. Currently there are two parameters within this section, model and skipValidation.

model

The model parameter is expecting a JSON meta-schema. The quickest way to learn how to write a meta-schema is through JSON-Schema's getting started page. An example of a meta-schema in action is our project configuration meta-schema, which can be found here.

skipValidation

The skipValidation parameter is as it sounds, it skips the model validation process. To ensure Codr properly reads your dataset samples, we validate each sample against the model. If you wish, you may enable skipValidation to either speed up the setup process, or remove the annoyance on the rare occasion that your samples are known to be very different.

Example

{
  "sample": {
    "skipValidation": false,
    "model": {
      "type": "object",
      "properties": {
        "sample_id": { "type": "string" },
        "app_name": { "type": "string" },
        "class_name": { "type": "string" },
        "method_name": { "type": "string" },
        "information_accessed": { "type": "string" },
        "apis": {
          "type": "array",
          "items": {
            "type": "array",
            "items": { "type": "string" },
            "minItems": 2,
            "maxItems": 2
          }
        },
        "hops": {
          "type": "array",
          "items": { "type": "string" }
        },
        "options": {
          "type": "array",
          "items": { "type": "string" }
        }
      },
      "required": ["sample_id", "apis", "hops", "options"]
    }
  }
}

API definitions

General

Display

Display.inputs

Display.outputs

Sample