Skip to content

Latest commit

 

History

History
124 lines (74 loc) · 2.63 KB

README.md

File metadata and controls

124 lines (74 loc) · 2.63 KB
Raw

Table of contents

  1. How to start frontend
  2. Folder structure
  3. Acceptable interaction behavior

How to start frontend

1. Install Nodejs

2. Install required packages

Under "frontend" directory:

npm install

3. Compiles and hot-reloads for development

npm run serve

4. Compiles and minifies for production

npm run build

5. Run your unit tests

npm run test:unit

6. Lints and fixes files

npm run lint

Folder structure

node_modules

store packages downloaded by npm.

public

lean more about public folder here

src

actual code for the frontend. more structure details here

tests

unit testing code

.env

environmental variable

.eslintrc.js

configuration for ESLint

.gitignore

files should not be pushed to git listed here

babel.config.js

configuration for Babel

.jest.config.js

configuration for Jest

package.json

required package for the frontend

Acceptable interaction behavior

Tasks

1. Sentiment Analysis

  • one document can have multiple different label.
  • no duplicated label allowed for same document.

2. Named Entity Recognition

  • one chunk (a word or sentence) can only be annotated by one label.
  • one label can be applied to multiple chunks.

3. Relation Extraction

  • In one relation, subject and object can not be the same chunk.
  • Different relation are not related. So one chunk can be the object in relation A, it can also be the object in relation B. It can also be subject in relation C.
  • no duplication relation (subject, object and label are all the same) is allowed

Explanations

1. Natural Language Explanation

  • user should select a template from the dropdown and fill in the blank.
  • no duplicate explanation is allowed.

2. Trigger Explanation

  • one trigger explanation group is one row of explanation.
  • one trigger is one selection of chunk.
  • one trigger explanation group can have multiple trigger selection.
  • no duplicate trigger is allowed within one trigger explanation group.
  • Within two different trigger explanation group, the same chunk can be selected more than once.