Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.01 KB

README.md

File metadata and controls

55 lines (33 loc) · 2.01 KB
Raw

mentor-classifier

A short answer classifier service focused on cold-start performance

This repo contains two subprojects:

  • mentor-classifier: core implementation of training and inference
  • mentor-classifier-api: a REST api for answer classification as a service in the app

Requirements

  • [recommended] penv to simplify python version management.
  • python3.8 (must be in path as python3.8 to build virtualenv)
  • make
  • poetry for dependency management

Development

Generally you'll be working in the sub projects, so refer to README there within

Licensing

All source code files must include a USC open license header.

To check if files have a license header:

make test-license

To add license headers:

make license

Releases

Currently, this image is semantically versioned. When making changes that you want to test in another project, create a branch and PR and then you can release a test tag one of two ways:

To build/push a work-in-progress tag of mentor-classifier for the current commit in your branch

To build/push a pre-release semver tag of mentor-classifier for the current commit in your branch

  • create a github release from your development branch with tag format /^\d+\.\d+\.\d+(-[a-z\d\-.]+)?$/ (e.g. 1.0.0-alpha.1)
  • this will create a tag like mentorpal/mentor-classifier:1.0.0-alpha.1
  • you can follow progress in github actions

Once your changes are approved and merged to main, you should create a release tag in semver format as follows:

  • create a github release from main with tag format /^\d+\.\d+\.\d$/ (e.g. 1.0.0)
  • this will create a tag like mentorpal/mentor-classifier:1.0.0
  • you can follow progress in github actions