dsfsi/dsfsi-lid

Language Identification For South African languages DSFSI Project Starter ============================== _This documentation is aimed to help provide information that explains what a project is about._ Last updated: August 2023 ## Table of contents 1. Project Description 2. Project Organization 3. Getting Started 4. Authors 5. More Information ## Project Description ----------- A short description of the project. ## Project Organization ------------ ├── LICENSE ├── Makefile requirements.txt` │ ├── setup.py Project based on the cookiecutter data science project template . #cookiecutterdatascience ## Getting Started ----------- _This section provides the necessary information for a user to be able to run the code locally._ ### Prerequisites Provide a summary of the list software and the version required to run the code. An example of this is : - Python 3.11.3 ### Installation Provide the instructions and code necessary to setup the required software environment for the code. An example of this is : 1. Run the setup.py to build the src python package 2. Run the requirements.txt to install all the required libraries, modules, and packages. ``` python setup.py install pip install -r requirements.txt ``` ### Usage Provide information and code on how to run the code and use the code. This includes instructions and examples of inputs and outputs. An example of this is : 1. To use the code , run the following line: ``` python src/main.py ``` ## Authors ----------- * Written by : * Contact details : ### Contributions This is optional and provides information about which and how each of the developers contributed. ## More Information --------- Provide any relevant informations about the project.