cga-telice commited on
Commit
eaf0fe2
·
verified ·
1 Parent(s): a98bf15

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -63
README.md DELETED
@@ -1,63 +0,0 @@
1
- # SafeMate
2
-
3
- Welcome to **SafeMate**, an occupational health and safety assistant designed to serve construction field workers. This project is currently in the proof of concept stage and aims to provide immediate, accessible safety guidelines and answers derived from authoritative sources. The core of this assistant is built upon a chat interface that draws its responses from the safety manual provided by the Port of Seattle, offering a practical and user-friendly approach to workplace safety.
4
-
5
- ## Project Overview
6
-
7
- SafeMate is crafted to transform the way construction workers interact with safety manuals, making it easier than ever to get answers to crucial safety questions on the job. By leveraging state-of-the-art machine learning models and natural language processing techniques, SafeMate delivers relevant safety information through a simple chat interface.
8
-
9
- ### Current State of the Project
10
-
11
- This project is in its early stages, and the current implementation serves as a proof of concept. The backbone of SafeMate is a chat interface that allows users to query a safety manual, specifically the one provided by the Port of Seattle, which is publicly available online.
12
-
13
- ### Project Structure
14
-
15
- The project is organized as follows:
16
-
17
- D:.
18
- ├───.chainlit
19
- │ └───translations
20
- ├───.files
21
- ├───app
22
- ├───data
23
- │ ├───processed
24
- │ ├───raw
25
- │ └───results
26
- ├───models
27
- ├───notebooks
28
- │ └───.ipynb_checkpoints
29
- ├───scripts
30
- ├───utils
31
- └───__pycache__
32
-
33
- Note: Some folders have been created to accommodate future developments and are not in use at the moment.
34
-
35
- ### Achievements So Far
36
-
37
- 1. **Synthetic QA Development**: Utilization of the RAGAS library to assess embeddings and models for effective question-answering.
38
- 2. **Data Processing**: Transformation of the raw PDF manual into a structured format, with embeddings stored in a vector store for quick retrieval.
39
- 3. **User Interface**: Implementation of ChainLit as the user interface, facilitating a seamless interaction where users can prompt questions, and the system retrieves context to provide informed responses.
40
- 4. **Accessibility**: The project's code is hosted on GitHub, with a live demo available on a Hugging Face space, demonstrating the capabilities and potential of SafeMate.
41
-
42
- ## Future Directions
43
-
44
- As SafeMate evolves, we plan to expand the knowledge base beyond the Port of Seattle's safety manual, incorporate feedback mechanisms for continuous improvement, and refine our models for better accuracy and user experience.
45
-
46
- ## Contact
47
-
48
- Cesáreo González Alvarez
49
- Github: cga-telice
50
- Linkedin: (https://www.linkedin.com/in/caesaripse/)
51
-
52
- ## License
53
-
54
- SafeMate is released under the [MIT License](LICENSE).
55
-
56
- ## Acknowledgments
57
-
58
- A special thank you to the Port of Seattle for making their safety manual publicly accessible and serving as the foundation for this project.
59
-
60
- ---
61
-
62
- For more information, updates, and to try out the SafeMate proof of concept, please visit our [GitHub repository](link-to-repo) and [Hugging Face demo space](link-to-demo).
63
-