Skip to content

Koel Labs innovates real-time pronunciation feedback for language learners! This repo contains the Python server that runs our ML inference

License

Notifications You must be signed in to change notification settings

KoelLabs/server

Repository files navigation

KoelLabsLogoLong

Mozilla Builders Patreon PayPal

Koel Labs - Server

Black Formatting PyTest Zizmor Gitleaks Secret Scanning Deploy to Production

Contains the Python server that runs our ML inference. It is used by our webapp repository and can be run directly as part of the webapp following instructions in that repository.

Read about all our repositories here.

Setup

See the DEVELOPMENT.md file for instructions on how to set up the server for development as well as for alternative setup instructions.

  1. git clone https://github.com/KoelLabs/server.git
    • On Windows, install Git first. Recommended: use the included git-bash to run the commands in the rest of the instructions.
  2. Install Docker and Docker Compose
  3. Duplicate the .env.example file and rename it to .env. Fill in the necessary environment variables.
    • You can find your HF_TOKEN on your Settings Page. It just needs read access to gated repos.
  4. Run the application
    • . ./scripts/docker-run-dev.sh to start the development server
    • If http://localhost:8080 doesn't automatically open in your browser, open it manually
    • ctrl+c to stop the server

Contributing

Check out the CONTRIBUTING.md file for specific guidelines on contributing to this repository.

We are grateful for all of our contributors. If you contribute to this repository and wish to be acknowledged, please add your name to the list in your pull request.

License

The code in this repository is licensed under the GNU Affero General Public License.

We retain all rights to the Koel Labs brand, logos, blog posts and website content.

About

Koel Labs innovates real-time pronunciation feedback for language learners! This repo contains the Python server that runs our ML inference

Resources

License

Stars

Watchers

Forks