Extraction-based Turkish news summarizer.
Project description
SadedeGel: An extraction based Turkish news summarizer
SadedeGel is a library for extraction-based news summarizer using pretrained BERT model. Development of the library takes place as a part of Açık Kaynak Hackathon Programı 2020
💫 Version 0.1 out now! Check out the release notes here.
📖 Documentation
| Documentation | |
|---|---|
| Contribute | How to contribute to the sadedeGel project and code base. |
💬 Where to ask questions
The SadedeGel project is maintained by @globalmaksmum AI team members @dafajon, @askarbozcan, @mccakir and @husnusensoy.
| Type | Platforms |
|---|---|
| 🚨 Bug Reports | GitHub Issue Tracker |
| 🎁 Feature Requests | GitHub Issue Tracker |
Features
Coming soon...
📖 **For more details, see the
Coming soon...
Install spaCy
For detailed installation instructions, see the documentation.
- Operating system: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual Studio)
- Python version: 3.5+ (only 64 bit)
- Package managers: pip
pip
Using pip, sadedeGel releases are available as source packages and binary wheels.
pip install sadedegel
When using pip it is generally recommended to install packages in a virtual environment to avoid modifying system state:
python -m venv .env
source .env/bin/activate
pip install sadedegel
conda
Coming soon...
Quickstart with SadedeGel
To load SadedeGel, use sadedegel.load()
import sadedegel
from sadedegel.dataset import load_sentence_corpus, load_raw_corpus
nlp = sadedegel.load()
tokenized = load_sentence_corpus()
raw = load_sentence_corpus()
summary = nlp(raw[0])
summary = nlp(tokenized[0], sentence_tokenizer=False)
PyLint, Flake8 and Bandit
sadedeGel utilized pylint for static code analysis, flake8 for code styling and bandit for code security check.
To run all tests
make lint
Run tests
sadedeGel comes with an extensive test suite. In order to run the
tests, you'll usually want to clone the repository and build sadedeGel from source.
This will also install the required development dependencies and test utilities
defined in the requirements.txt.
Alternatively, you can find out where sadedeGel is installed and run pytest on
that directory. Don't forget to also install the test utilities via sadedeGel's
requirements.txt:
make test
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sadedegel-0.1.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | afd6b6cd60c4f091ff364687e70e5864c4f417b2743b266d7d84359ca248c5aa |
|
| MD5 | d7c4d0c1ea08d283caa8298922475c73 |
|
| BLAKE2b-256 | cb4ec05f3244d883adc74d53e8b2a074248690ba7cb839d19b277ee99ab1bf19 |
