Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clubgamma/summarize-papers
Official Hacktoberfest 2024 project repository from Club Gamma. Start hacking!
https://github.com/clubgamma/summarize-papers
aiml hacktoberfest hacktoberfest2024
Last synced: 1 day ago
JSON representation
Official Hacktoberfest 2024 project repository from Club Gamma. Start hacking!
- Host: GitHub
- URL: https://github.com/clubgamma/summarize-papers
- Owner: clubgamma
- Created: 2024-10-09T12:51:29.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2024-10-21T12:21:07.000Z (17 days ago)
- Last Synced: 2024-10-21T18:12:37.975Z (17 days ago)
- Topics: aiml, hacktoberfest, hacktoberfest2024
- Language: Jupyter Notebook
- Homepage:
- Size: 43.4 MB
- Stars: 1
- Watchers: 0
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Summarized Paper Project
## Project Overview 🌍
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.
### Key Features:
- **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.
## Project Structure 📁
```bash
.
├── 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
```
## Getting Started 🤗🚀
To contribute to the project, follow these steps:
### Fork the Repository:
Click the fork button at the top right of the repository page.
### Clone Your Fork:
Clone the forked repository to your local machine.
```bash
git clone https://github.com/your-username/summarized-paper-project.git
```
### Navigate to the Project Directory:
```bash
cd summarized-paper-project
```
### Create a New Branch:
```bash
git checkout -b my-new-branch
```
### Make Your Changes:
Add your features or improvements to the project.
### Commit Your Changes:
```bash
git add .
git commit -m "Add relevant message here"
```
### Push to Your Branch:
```bash
git push origin my-new-branch
```
### Create a Pull Request:
Go to your forked repository on GitHub and create a pull request to the main repository.
---
## Contribution Guidelines 📚
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.
---
## Avoiding Conflicts (Syncing Your Fork) 🔄
To keep your fork up to date with the main repository:
### Add Upstream Remote:
```bash
git remote add upstream https://github.com/clubgamma/summarized-paper-project.git
```
### Verify the New Remote:
```bash
git remote -v
```
### Sync Your Fork with Upstream:
```bash
git fetch upstream
git merge upstream/main
```
---
## Add Your Name 🌟
Please add your name to the `CONTRIBUTING.md` file using the following format:
#### Name: [YOUR NAME](GitHub link)
- Place: City, State, Country
- Bio: Who are you?
- GitHub: [GitHub account name](GitHub link)
---
## Pull Request Labels
We have the following PR labels:
- `level 1` - Basic level contributions
- `level 2` - Intermediate level contributions
- `level 3` - Advanced level contributions
- `hacktoberfest-accepted` - Contributions accepted for Hacktoberfest
---
We look forward to your contributions! 🎉