🐈 Code Annotation Tool
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
cli
helm-charts/code-annotation
public
server
src
vendor
.dockerignore
.drone.yml
.editorconfig
.env.tpl
.eslintrc.js
.gitignore
.helm-production.yml
.helm-staging.yml
.prettierrc
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DCO
Dockerfile
Gopkg.lock
Gopkg.toml
LICENSE
MAINTAINERS
Makefile
README.md
config-overrides.js
package.json
setupJest.js
yarn.lock

README.md

Build Status unstable

Source Code Annotation Tool

Training Machine Learning models often requires large datasets to be duly annotated. The nature of these annotations vary depending on the dataset considered: they can be the number to be recognized in the MNIST dataset, the coordinates of the box containing the objects to be identified in an object detection problem, etc.

This tool provides a simple UI to add annotations to existing datasets, a command line tool to fetch more elements to be annotated, and an export mechanism.

Currently, the project provides one single example consisting of labeling two pieces of code as being identical, similar, or different.

Source code annotation tool offers a UI to annotate source code and review these annotations, and a CLI to define the code to be annotated and export the annotations.

Screenshot

Installation

Environment Variables

The next sections make use of several environment variables to configure the application. In this table you will find all of them grouped as a quick reference:

Variable Required Default value Meaning
CAT_JWT_SIGNING_KEY YES - Key used to sign JWT (JSON Web Tokens) in the server
CAT_OAUTH_CLIENT_ID YES - GitHub application OAuth credentials
CAT_OAUTH_CLIENT_SECRET YES - GitHub application OAuth credentials
CAT_OAUTH_RESTRICT_ACCESS - Application access control based on GitHub groups or teams
CAT_OAUTH_RESTRICT_REQUESTER_ACCESS - User role control based on GitHub groups or teams
CAT_HOST 0.0.0.0 IP address to bind the HTTP server
CAT_PORT 8080 Port address to bind the HTTP server
CAT_SERVER_URL <CAT_HOST>:<CAT_PORT> URL used to access the application (i.e. public hostname)
CAT_DB_CONNECTION sqlite:///var/code-annotation/internal.db Points to the internal application database. Read below for the complete syntax
CAT_EXPORTS_PATH ./exports Folder where the SQLite files will be created when requested from http://<your-hostname>/export
CAT_ENV production Sets the log level. Use dev to enable debug log messages

Github OAuth Tokens

In order to authenticate users with their Github account, you need to set up an OAuth application on GitHub. See how to create OAuth applications in their documentation. Make sure the "Authorization callback URL" points to http://<your-hostname>/oauth-callback.

Retrieve the values for your application's Client ID and Client Secret from the GitHub Developer Settings page and set them to the environment variables CAT_OAUTH_CLIENT_ID and CAT_OAUTH_CLIENT_SECRET.

Docker

$ docker run \
    -e CAT_OAUTH_CLIENT_ID=XXXX \
    -e CAT_OAUTH_CLIENT_SECRET=YYYY \
    -e CAT_JWT_SIGNING_KEY=ZZZZ \
    --rm -p 8080:8080 srcd/code-annotation

Non-docker

Download the binary from releases for your platform.

Importing and Exporting Data

Import File Pairs for Annotation

The pieces of code to be labeled are called file pairs. They must be provided via an SQLite database. The database must follow the expected schema, please follow this link to see an example.

The import command will use those file pairs to create a new SQLite or PostgreSQL database that will be used internally by the Annotation Tool. The destination database does not need to be empty, new imported file pairs can be added to previous imports.

Note: duplicate entries are not filtered, so running an import multiple times will result in repeated rows.

To use it, run it as:

$ import <path-to-sqlite.db> <destination-DSN>

Where the DSN (Data Source Name) argument must be one of:

  • sqlite:///path/to/db.db
  • postgresql://[user[:password]@][netloc][:port][,...][/dbname]

Some usage examples:

$ import ./input.db sqlite:///home/user/internal.db
Imported 989 file pairs successfully

$ import /home/user/input.db postgres://testing:testing@localhost:5432/input?sslmode=disable
Imported 562 file pairs successfully

For a complete reference of the PostgreSQL connection string, see the documentation for the lib/pq Go package.

Set the Internal Database Connection

Before starting the application you will need to set the CAT_DB_CONNECTION environment variable. It should point to the database created with the import command.

This variable uses the same DSN string as the import command to point to an SQLite or PostgreSQL database.

Some examples:

CAT_DB_CONNECTION=sqlite:///home/user/internal.db
CAT_DB_CONNECTION=postgres://testing:testing@localhost:5432/input?sslmode=disable

Export Annotation Results

To work with the annotation results, the internal data can be extracted into a new SQLite database using the export command.

$ export <origin-DSN> <path-to-sqlite.db>

The DSN argument uses the same format as the import tool, see the previous section.

In this case, origin will be the internal database, and destination the new database. This new database will have the same contents as the internal one.

You can also download the results database from the web interface visiting:

http://<your-hostname>/export

The annotations made by the users will be stored in the assignments table.

Access Control

It is possible to restrict access and choose each user's role by adding their GitHub accounts to a specific organization or team.

This is optional, but if you don't set any restrictions, all users with a valid GitHub account will be able to log in as a Requester. You may also set a restriction only for Requester users, and leave open access to anyone as Workers.

To do so, set the following environment variables:

  • CAT_OAUTH_RESTRICT_ACCESS
  • CAT_OAUTH_RESTRICT_REQUESTER_ACCESS

Both variables accept a string with either org:<organization-name> or team:<team-id>. For example:

CAT_OAUTH_RESTRICT_ACCESS=org:my-organization
CAT_OAUTH_RESTRICT_REQUESTER_ACCESS=team:123456

source{d} internal deployment

This application is deployed in production and staging sourced{d} environments following our web application deployment workflow

Contributing

Contributions are more than welcome, if you are interested please take a look at our Contributing Guidelines. You have more information on how to run it locally for development purposes here.

Code of Conduct

All activities under source{d} projects are governed by the source{d} code of conduct.

License

GPLv3, see LICENSE