Theia

Theia is a recommender system for therapists that considers both the therapist's and the client's preferences to make recommendations. The therapist's preferences are considered when making suggestions for clients. The therapist can set different weights for different criteria, such as the type of therapy, the client's needs, and the therapist's expertise. The client's preferences are considered when making suggestions for therapists. The client can set different weights for different criteria, such as the type of therapy, the therapist's approach, and the therapist's location. Theia takes into account both the therapist's and the client's preferences to make the best possible recommendations.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Python, version 3.6 or later
Python Virtual Environment, version 16.0 or later

Installing

A step by step series of examples that tell you how to get a development env running

Clone the repository using below command

git clone https://github.com/thomiaditya/theia.git
cd theia

Windows

# Activate the virtual environment
python -m venv .
.\Scripts\activate
pip install .

Linux

# Activate the virtual environment
python3 -m venv .
source bin/activate
pip3 install .

After that you can run the application using below command

theia server start

Above command will run the application in the current directory.

You can see all the command available by typing theia -h

Deployment

This will cover the deployment of the application on a server using Docker. So you need to have Docker installed on your machine (server/cloud).

First, prepare some folders and files for the deployment,

Credentials for the Google Cloud Storage in order to download the dataset from the cloud (This is internal to the project and not shared with anyone)
Folder for the history of the model (It includes the saved model and checkpoints)
Environment variables .env file (It contains the environment variables for the Docker container). See .env.example for an example.

You can run the following command after all the files are prepared

# Build the server image
docker build -t theia-server .

# Run the server image
docker run -p 8080:WHATEVER_PORT_IN_ENV \
    -v LOCAL_PATH_TO_CREDENTIAL:/root/.credentials \
    -v LOCAL_PATH_TO_HISTORY:/root/.history \
    --env-file LOCAL_ENV_PATH \
    -d \
    theia-server

Built With

Tensorflow, for model training and deployment also Keras
Wandb, for hyperparameter tuning and experiment tracking
Python Virtual Environment, to manage project dependencies

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Thomi Aditya - Initial work - Github

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Hat tip to anyone whose code was used
Inspiration
etc

muhamadarif085 / theia