Skip to content

Commit

Permalink
The readme now contains information on testing
Browse files Browse the repository at this point in the history
  • Loading branch information
AsbjoernJC authored Dec 1, 2023
1 parent 3bbe998 commit 8f5a041
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Deployment is normally handled by Watchtower on push to main. However, in case o

`http://knox-preproc01.srv.aau.dk:4444/tripleconstruction`

## Testing
The testing framework <a href="https://docs.python.org/3/library/unittest.html"> unittest </a> has been utilised to test the solution. The testing framework discovers all directories with the naming convention `test_`. In addition, all Python files beginning with `test_` inside those directories will be run.

## Naming conventions

This repository uses the snake-case naming convention
Expand All @@ -59,6 +62,9 @@ The solution developed by group C to perform relation extraction on sentences wi

Is the solution developed by group D to perform concept linking on sentences with entity mentions and IRIs pointing to the entities.

### /test
The directory containing the tests for the solutions. The testing framework <a href="https://docs.python.org/3/library/unittest.html"> unittest </a> has been utilised to test the solution. The testing framework discovers all directories inside with the naming convention `test_`. In addition, all Python files beginning with `test_` will be run.

## Server documentation

### post endpoints
Expand Down

0 comments on commit 8f5a041

Please sign in to comment.