Git Product home page Git Product logo

language-proficiency-estimator's Introduction

Language Proficiency Estimator

Netlify Status

An AI powered web-app for estimating language proficiency expectations of adult English learners.

The application can be accessed at the following URL:

https://language-proficiency-estimator.netlify.app

Running the application locally

To run the application locally for evaluation or development purposes:

  1. Start the backend server
  2. Start the frontend server
  3. Visit http://localhost:5173 in a web browser

1. Starting the backend server

Requires Python 3

Install dependencies

The backend server requires the following python packages to be installed: (See backend/requirements.txt)

  • Flask
  • torch
  • flask_cors
  • scikit-learn
  • matplotlib
  • numbpy

These may be installed by using pip / pip3

pip3 install Flask torch flask_cors scikit-learn matplotlib

Or in Unix-like environments, they may also be installed using venv from the backend directory.

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt

Launching the server

Once the dependancies have been installed, the server may be started by running the following command from the backend directory.

flask run

2. Starting the frontend server

Install dependencies

Node (v. 18 or greater) and npm are required. From the frontend directory run the following:

npm install

Launching the server

npm run dev

The full working application should now be accessible at http://localhost:5173

Deployment:

Backend

The backend can be deployed using Fly.io. To deploy, install flyctl and then from the backend directory run:

fly deploy

Frontend

Environment variables:

Building the frontend for production deployment requires the following environment variable to be set:

  • VITE_PROFICIENCY_API - URL for the backend proficiency model API (defaults to http://localhost:500)

Building

To build the frontend for deployment run the following command from the frontend directory:

npm run build

The frontend/dist directory contains the packaged front-end files for deployment.

Training the model

This repository includes a pre-trained model at backend/model.pt. But you can also train it by running the following from the backend directory.

python3 train.py

Dataset and Visualizations

The model has been trained on the BEST Dataset of Language Proficiency. Below are some visualizations of the data from this dataset.

image image image image image image

language-proficiency-estimator's People

Contributors

adueck avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.