Open Coding for Machine Learning is an annotation interface that allows a single annotator to efficiently and effectively devise labels and descriptions for a large, unlabeled dataset.
This interface requires the installation of npm (MacOS example) Ubuntu Example. This interface also requires the installation of Flask, and Hugging Face Transformers.
Homebrew is recommended for MacOS users.
To start, open your terminal and navigate into the OpenCodingForMachineLearning directory. The commands cd and ls may be helpful, as well as this guide.
When finished, the command ls should list out the five main directories of this project - data, interface, results, server, and training, in addition to a few other files.
To help make library installations and running the application more smooth, we have provided three executable files, setup.sh, opencoding.sh and shutdown.sh. These files likely already have read permissions, but we will need them to have execute permissions in order to run them later. More information about permissions can be found here.
Run the following commands to add execute permissions to our .sh files.
$ chmod +x setup.sh
$ chmod +x opencoding.sh
$ chmod +x shutdown.sh
This interface requires the installation of npm (MacOS example) Ubuntu Example.
Follow the instructions in the links above or your preferred method of installation for your machine to install npm.
Complete the remaining necessary installations by running the command
$ ./setup.sh
in the terminal within the OpenCodingForMachineLearning directory. If you have an M1 chip, you may run into issues installing the necesary dependies for the server part of the project - please see the README.md file within server for troubleshooting guidelines.
If any issues arise with installations, you may also consult the Development Instructions within the training, server, and interface directories' README.md files (in order).
To run the application, type the following command within the OpenCodingForMachineLearning directory in the terminal and press enter.
$ ./opencoding.sh
Then, navigate to http://localhost:3000/. Note that you may have to replace 'localhost' with your computer's IP address.
You should see the introduction page!
HappyDB is already available for annotation and label creation, in addition to a few other datasets. If you would like to upload your own dataset, please see Using Personal Data in the README.md file in the data directory.
When you're done using the application, close the http://localhost:3000/ tab and enter the following command into your terminal:
$ ./shutdown.sh
If you aren't able to type into your terminal, you may have to click on the terminal and press enter first.
If you accidentally close the terminal before shutting down the application, just open a new terminal and navigate back to OpenCodingForMachineLearning to try executing the shutdown command again.
This repository is split into five main sections - data, interface, results, server, and training. Each section has a README further detailing it's implementation, but a short summary is given here.
The csv files loaded by the annotation interface are located here. The csv files must follow the format
ID,TEXT,
0,DATASET_TITLE,
1,TEXT_1,
...,...,
N,TEXT_N,
or they will be unable to be processed. By default, a cleaned version of HappyDB is provided.
In the "data" folder, feel free to upload any csv files with the format specified above. Note that each entry must have a unique id.
Then, quit and re-run the executable. On the introduction page, the dropdown should now include your DATASET_TITLE.
All code necessary for the loading the webpage is located here, bootstrapped with Create React App.
This is where your final, labeled csv file will be saved.
All code necessary for storing, loading, and generating data for the website is located here. The local database is built using SQLite, and interactions between the Python backened and the Javascript frontend are achieved using Flask.
All classification models and any model training code exist here.