From ad35dd0dfd849477fc41b8617a2f79ca72655309 Mon Sep 17 00:00:00 2001 From: Ethan Ng Date: Tue, 12 Dec 2023 15:55:08 -0800 Subject: [PATCH] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c45d431..c88e7fa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ## Service Difficult Report (SDR) classifier package -:rocket: This is the source code for the SDR Classifier package that classifies potential aviation safety hazards. The work is a collaboration between FAA and Boeing data scientist teams +:rocket: This is the source code for the SDR Classifier package that classifies potential aviation safety hazards from textual data. The work is a collaboration between FAA and Boeing data scientist teams **Version 0.0.1 out now!** [Check out the release notes here.](https://github.com/Boeing/sdr-hazards-classification/releases) @@ -18,9 +18,10 @@ It is highly recommended to use venv, virtualenv or conda python environments. Read more about creating virtual environments via venv https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments -## Build the whl file and pip install whl file +## Build and pip install the whl file locally Run the command in the root folder to create the whl file in the _dist_ folder ``` +git clone https://github.com/Boeing/sdr-hazards-classification python setup.py bdist_wheel pip install sdr_classifier-0.0.2-py3-none-any.whl ```