HRBuddy is an open-source tool designed to assist users with their HR-related queries by leveraging the company's internal HR policies. It utilizes a Retrieval Augmented Generation (RAG) system architecture to provide efficient and accurate responses to user queries.
- Retrieves information from the company's internal HR policies.
- Generates relevant and personalized responses to user queries.
- Utilizes state-of-the-art natural language processing techniques.
- Provides a user-friendly interface for easy interaction.
To set up and run HRBuddy locally, follow these steps:
- Clone the repository:
git clone https://github.com/your_username/HRBuddy.git
- Navigate to the project directory:
cd HRBuddy
- Set up a virtual environment using Poetry:
poetry shell
- Install dependencies:
poetry install
- Start JupyterLab:
jupyter lab
- Open a web browser and navigate to the provided URL to access HRBuddy.
Once HRBuddy is set up and running, users can interact with it by following these steps:
- Enter your HR-related query into the provided interface.
- HRBuddy will process your query and retrieve relevant information from the company's HR policies.
- The system will generate a response based on the retrieved information and present it to the user.
Contributions to HRBuddy are welcome! If you'd like to contribute to the project, please follow these guidelines:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and ensure that they are properly tested.
- Submit a pull request detailing your changes and explaining their purpose.
HRBuddy is licensed under the MIT License. See the LICENSE file for more information.
Want to discuss anything you can reach me out here