Skip to content

This repo host my Research Assistant Work at NTU for Professor Chih-Sheng Hsieh.

Notifications You must be signed in to change notification settings

githubjacky/notorious

Repository files navigation

notorious

This repo host my Research Assistant Work at NTU for Professor Chih-Sheng Hsieh.

Tools used in this project

  • hydra: manage configuration files
  • DVC: data version control
  • sphinx: automatically create an API documentation for your project

Set up the environment, and Install dependencies

  1. Install docker
  2. modify the .env.example, assigning the environment variables and rename it as .env
  3. create the docker image:
make build

To clean up the docker image:

make clean

Container Services

# unit test
make pytest

# project documentation
# after typing the command open docs/_build//html/index.html in the browser
make doc

# development IDE - Jupyter Lab
make jupyter

# MLflow tracking UI
make mlflow

Usage

  1. download the MongoDB and start the server
  2. modify the .env.example, assigning the environment variables and rename it as .env
  3. modify the configuration file - config/main.yaml
  4. run the program
# 1.
make trend-search
# 2.
make adjust-ait
  1. stop the container(stop mongodb server also)
make down