Skip to content

Gayanukaa/Essay-Evaluator-LLM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Essay Evaluator LLM

This project is an essay evaluation application built using a Large Language Model (LLM). It allows users to input essays and receive detailed feedback on various aspects, including grammar, structure, and content relevance.

Overview

license last-commit repo-top-language repo-language-count

Developed with the software and tools below.

Python DSPy Streamlit Ollama WSL

Installation

  1. Clone the repository: git clone https://github.com/Gayanukaa/Essay-Evaluator-LLM.git
  2. Navigate to the project directory: cd Essay-Evaluator-LLM
  3. Set up the environment with dependencies: conda env create -f environment.yml -n dspy-dev
  4. Activate the environment required for the application: conda activate dspy-dev
  5. Run the application: streamlit run app.py

Prerequisites

Before running this application, make sure you have the following tools installed:

Download local model required. eg. llama2 7B

curl -fsSL https://ollama.com/install.sh | sh
ollama pull llama2

Usage

  • Open your web browser and navigate to http://localhost:8501 to access the Streamlit interface.
  • Submit essays through the application to receive feedback and analysis.

Comprehensive Guide

My detailed guide on how to run the project on local models. Check out my Medium article.

Medium Article Cover Image

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Submit a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions, please feel free to reach out to us at gayanukaamarasuriya@gmail.com.