Skip to content

Marconi-Lab/evaluation_system

 
 

Repository files navigation

A system to evaluate various TTS model versions.

After several TTS(Text to Speech) architectures are used to buid a Luganda TTS model, we made a system to run the evaluation tests in order to determine which is best. We will use the MOS(Mean Opinion Score) approach.

How to use

Clone this repository For testing purposes ensure you can run the commands below

Execute create-next-app with npm or Yarn to bootstrap the example:

Application sections

AuthO

TTS Server to plug in your model

This may be the most confusing part but you need an api to plug in your sentence generation sections

Prisma DB

Configuring Auth0

Read more: https://auth0.com/blog/ultimate-guide-nextjs-authentication-auth0/

  1. Go to the Auth0 dashboard and create a new application of type Regular Web Applications and make sure to configure the following
  2. Go to the settings page of the application
  3. Configure the following settings:
  • Allowed Callback URLs: Should be set to http://localhost:3000/api/callback when testing locally or typically to https://myapp.com/api/callback when deploying your application.
  • Allowed Logout URLs: Should be set to http://localhost:3000/ when testing locally or typically to https://myapp.com/ when deploying your application.
  1. Save the settings

Set up environment variables

To connect the app with Auth0, you'll need to add the settings from your Auth0 application as environment variables

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then, open .env.local and add the missing environment variables:

  • NEXT_PUBLIC_AUTH0_DOMAIN - Can be found in the Auth0 dashboard under settings. (Should be prefixed with https://)
  • NEXT_PUBLIC_AUTH0_CLIENT_ID - Can be found in the Auth0 dashboard under settings.
  • AUTH0_CLIENT_SECRET - Can be found in the Auth0 dashboard under settings.
  • NEXT_PUBLIC_BASE_URL - The base url of the application.
  • NEXT_PUBLIC_REDIRECT_URI - The relative url path where Auth0 redirects back to.
  • NEXT_PUBLIC_POST_LOGOUT_REDIRECT_URI - Where to redirect after logging out.
  • SESSION_COOKIE_SECRET - A unique secret used to encrypt the cookies, has to be at least 32 characters. You can use this generator to generate a value.
  • SESSION_COOKIE_LIFETIME - How long a session lasts in seconds. The default is 2 hours.

Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

To seed the database run

npx prisma db seed