An open API service indexing awesome lists of open source software.

https://github.com/xanonymous-github/suspension-data

The Data Science course final project, NTUT group 13, 2023
https://github.com/xanonymous-github/suspension-data

csv data-science poetry-python

Last synced: 10 months ago
JSON representation

The Data Science course final project, NTUT group 13, 2023

Awesome Lists containing this project

README

          

Suspension Data
=================================

Introduction
------------

The Suspension Project aims to organize government-provided data on student leave reasons and present it in a visual
format on a website using Vue3. The data processing for this project is done in Python. Additionally, OpenAI's fine-tune
is used to train a GPT model for predicting data traits changes.

Objective
---------

The objective of the Suspension Project is to create a user-friendly website that displays student leave reasons data in
an easily understandable and visually appealing manner. By organizing the government-provided data, we aim to provide
valuable insights into student leave patterns and reasons. The integration of OpenAI's fine-tuned GPT model allows us to
make predictions about future data traits changes based on historical patterns.

Usage
-----

Please make sure you have these tools installed:

- `poetry`
- `pyenv`
- `pre-commit`

To get the Suspension Project, follow this steps:

- Clone the repository:

```bash
git clone git@github.com:Xanonymous-GitHub/suspension-data.git
```

- Install specific python environment:

```bash
pyenv install 3.10
```

- Change to that version of python locally:

```bash
pyenv local 3.10
```

- Switch to the python environment:

```bash
poetry env use "$(pyenv which python3)"
```

- Install dependencies:

```bash
poetry install
```

- Install pre-commit hooks:

```bash
pre-commit install
```

- Start the development shell:

```bash
poetry shell
```

- Execute the main script:

```bash
python3 suspension_data/main.py
```

Checks
-----

The following checks should be run on every commit:

- `pylint $(git ls-files '*.py')`
- `black $(git ls-files '*.py')`
- `isort $(git ls-files '*.py')`
- `pytype $(git ls-files '*.py')`

License
-------

The Suspension Project is licensed under the MIT License. Please review the license file for more information.

Contact
-------

If you have any questions, suggestions, or feedback regarding the Suspension Project, please contact the project
maintainer or open an issue in the repository.