The Summarized Paper Project aims to utilize machine learning techniques to condense lengthy academic papers into concise summaries. This project addresses the challenge of information overload in academic research, making it easier for researchers and students to grasp essential concepts quickly.
- Text Processing: Cleaning and pre-processing text data from academic papers.
- Summarization Models: Implementing models such as BERT, GPT, and other NLP techniques to generate summaries.
- User Interface: A simple web interface for users to input text and receive summarized output.
- Evaluation: Measuring summary quality through ROUGE scores and user feedback.
The project aims to facilitate faster comprehension of academic research by providing automated summarization tools.
.
├── data/ # Datasets for academic papers
├── notebooks/
│ ├── summarization of a long text.ipynb #jupyter notebook for a long text which can be summarized by all pretrained models
│ ├── summarize-papers.ipynb # a single notebook for summarization of academic papers
│ ├── summarization.ipynb # notebook with main function stored inside src/summarization_utils.py
├── src/ # Source code for the project
│ ├── summarization_utils.py # Python file which contains all the function
│ ├── data_prosessing.py
│ ├── model_training.py
├── README.md # Project documentation
└── CONTRIBUTING.md # Contribution guidelines
To contribute to the project, follow these steps:
Click the fork button at the top right of the repository page.
Clone the forked repository to your local machine.
git clone https://github.com/your-username/summarized-paper-project.git
cd summarized-paper-project
git checkout -b my-new-branch
Add your features or improvements to the project.
git add .
git commit -m "Add relevant message here"
git push origin my-new-branch
Go to your forked repository on GitHub and create a pull request to the main repository.
We welcome your contributions! Please follow these guidelines:
- Creativity Allowed: Submit pull requests even if they break the rules—we may merge them anyway!
- Preserve Existing Content: Don’t remove existing content.
- Code Style: Your code can be neat, messy, or complex—as long as it works!
- Add Your Name: Remember to add your name to the
contributorsList
file. - Keep it Small: Small pull requests help prevent merge conflicts.
To keep your fork up to date with the main repository:
git remote add upstream https://github.com/clubgamma/summarized-paper-project.git
git remote -v
git fetch upstream
git merge upstream/main
Please add your name to the CONTRIBUTING.md
file using the following format:
- Place: City, State, Country
- Bio: Who are you?
- GitHub: [GitHub account name](GitHub link)
We have the following PR labels:
level 1
- Basic level contributionslevel 2
- Intermediate level contributionslevel 3
- Advanced level contributionshacktoberfest-accepted
- Contributions accepted for Hacktoberfest
We look forward to your contributions! 🎉