diff --git a/README.md b/README.md index f6f6625df3879962f5671f8b9fdd3f0d548c32c5..bd59ecabde4fc257c769f669d526b790e9e91693 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,174 @@ -# NLP Group 43 +# COMM061 - NATURAL LANGUAGE PROCESSING - GROUP 43 +## Overview -## Getting started +This project is designed to deploy a Flask application that utilizes the SciBERT model for various NLP tasks. The project includes a Jupyter notebook, `app.ipynb`, which is converted to a Python script during the CI/CD pipeline. The application is deployed using a CI/CD pipeline configured in GitLab. -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## Table of Contents -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +- [Project Structure](#project-structure) +- [Requirements](#requirements) +- [Setup](#setup) +- [Usage](#usage) +- [CI/CD Pipeline](#cicd-pipeline) +- [License](#license) -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +## Project Structure ``` -cd existing_repo -git remote add origin https://gitlab.surrey.ac.uk/lm01906/nlp-group-43.git -git branch -M main -git push -uf origin main +. +├── app.ipynb # Jupyter notebook for the application +├── requirements.txt # List of dependencies +├── pipeline.sh # Shell script for building the project +├── .gitlab-ci.yml # GitLab CI/CD pipeline configuration +└── README.md # Project documentation ``` -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.surrey.ac.uk/lm01906/nlp-group-43/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +## Requirements -*** +- Python 3.8+ +- Flask +- Gunicorn +- Jupyter +- nbconvert +- PyTorch +- NumPy +- Transformers +- Datasets +- Evaluate +- Seqeval -# Editing this README +You can find all required packages listed in `requirements.txt`. -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +## Setup -## Suggestions for a good README +1. **Clone the repository:** -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. + ```sh + git clone <repository-url> + cd <repository-directory> + ``` -## Name -Choose a self-explaining name for your project. +2. **Set up a virtual environment and install dependencies:** -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. + ```sh + python3 -m venv .venv + source .venv/bin/activate + pip install -r requirements.txt + ``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +3. **Run the application:** -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. + ```sh + nohup python3 app.py & + ``` ## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +1. **Converting the Jupyter Notebook:** + + Convert `app.ipynb` to a Python script: + + ```sh + jupyter nbconvert --to script app.ipynb + ``` + +2. **Running the Flask Application:** + + Ensure that `app.py` is present in the project directory after conversion. Then, start the Flask application: + + ```sh + python3 app.py + ``` + +3. **Access the Application:** + + By default, the Flask application runs on `http://127.0.0.1:8080`. Open this URL in your web browser to access the application. + +## CI/CD Pipeline + +The project includes a CI/CD pipeline configured in `.gitlab-ci.yml` to automate the build and deployment process. The pipeline has the following stages: + +1. **Install:** + - Installs dependencies from `requirements.txt`. + +2. **Test:** + - Runs tests using `pytest`. + +3. **Build:** + - Converts the Jupyter notebook to a Python script. + - Ensures the conversion was successful. + +4. **Deploy:** + - Deploys the Flask application. + - Ensures the application runs in the background. + +### Pipeline Configuration + +Here is a brief overview of the `.gitlab-ci.yml` configuration: + +```yaml +stages: + - install + - test + - build + - deploy + +variables: + VIRTUAL_ENV: ".venv" + PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" + +cache: + paths: + - .cache/pip + +before_script: + - python3 -m venv $VIRTUAL_ENV + - source $VIRTUAL_ENV/bin/activate + - pip install -r requirements.txt + +install: + stage: install + script: + - echo "Installing dependencies..." + - pip install -r requirements.txt + artifacts: + paths: + - $VIRTUAL_ENV + +test: + stage: test + script: + - echo "Running tests..." + - pytest tests/ + artifacts: + when: always + reports: + junit: junit.xml + +build: + stage: build + script: + - echo "Building the project..." + - jupyter nbconvert --to script app.ipynb + - if [ ! -f app.py ]; then echo "Conversion failed, exiting pipeline"; exit 1; fi + - echo "Build completed successfully." + artifacts: + paths: + - app.py + +deploy: + stage: deploy + script: + - echo "Deploying the application..." + - nohup python3 app.py & + - sleep 5 + - echo "Application should have started in the background." + only: + - main +``` ## License -For open source projects, say how it is licensed. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.