https://github.com/kudashevs/rake-php
A PHP implementation of the Rapid Automatic Keyword Exraction (RAKE) algorithm.
https://github.com/kudashevs/rake-php
keywords keywords-extraction rake
Last synced: about 2 months ago
JSON representation
A PHP implementation of the Rapid Automatic Keyword Exraction (RAKE) algorithm.
- Host: GitHub
- URL: https://github.com/kudashevs/rake-php
- Owner: kudashevs
- License: mit
- Created: 2024-12-20T18:34:29.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-02-04T17:16:18.000Z (4 months ago)
- Last Synced: 2025-03-27T12:38:27.269Z (2 months ago)
- Topics: keywords, keywords-extraction, rake
- Language: PHP
- Homepage:
- Size: 114 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Rake PHP
[](https://packagist.org/packages/kudashevs/rake-php)
[](https://github.com/kudashevs/rake-php/actions/workflows/run-tests.yml)
[](LICENSE.md)
A PHP implementation of the Rapid Automatic Keyword Extraction (RAKE) algorithm for extracting relevant keywords from
individual documents.
## Installation
You can install the package via composer:
```bash
composer require kudashevs/rake-php
```
## Example
Here is a common usage example:
```php
use Kudashevs\RakePhp\Rake;
$text = "Compatibility of systems of linear constraints over the set of natural numbers.";
$text .= "Criteria of compatibility of a system of linear Diophantine equations, strict inequations, and nonstrict inequations are considered.";
$text .= "Upper bounds for components of a minimal set of solutions and algorithms of construction of minimal generating sets of solutions for all types of systems are given.";
$text .= "These criteria and the corresponding algorithms for constructing a minimal supporting set of solutions can be used in solving all the considered types of systems and systems of mixed types";
$rake = new Rake();
$keywords = $rake->extract($text);
print_r($keywords);
// will result in
Array
(
[minimal generating sets] => 8.6666666666667
[linear diophantine equations] => 8.5
[minimal supporting set] => 7.6666666666667
[minimal set] => 4.6666666666667
[linear constraints] => 4.5
[natural numbers] => 4
[strict inequations] => 4
[nonstrict inequations] => 4
[upper bounds] => 4
[mixed types] => 3.6666666666667
[considered types] => 3.1666666666667
[set] => 2
[types] => 1.6666666666667
[considered] => 1.5
[compatibility] => 1
[systems] => 1
[criteria] => 1
[system] => 1
[components] => 1
[solutions] => 1
[algorithms] => 1
[construction] => 1
[constructing] => 1
[solving] => 1
)
```
More information about RAKE and its usage, you can find in [the original paper](https://www.researchgate.net/publication/227988510_Automatic_Keyword_Extraction_from_Individual_Documents).
## Options
The `Rake` class accepts some configuration options:
```
'modifiers' => [] # A string, an instance or an array of Modifiers
'stoplist' => Stoplist::class # A Stoplist instance that provides a list of stop words
'sorter' => Sorter::class # A Sorter instance that sorts the output of the algorithm
'exclude' => [] # An array of words or regexes that will be excluded from a stoplist
'include' => [] # An array of words or regexes that will be included in a stoplist
```
**Note:** the configuration options `exclude` and `include` accept [simple regexes](#simple-regular-expressions).
**Note:** the configuration option `exclude` has a higher priority than the `include` option.
**Note:** At the moment of instantiation, the `Rake` class can throw an `InvalidOptionType` exception. This exception
extends a built-in `InvalidArgumentException` class, so it is easy to deal with.
### Simple regular expressions
The configuration options `exclude` and `include` accept regular expressions. The current expressions are currently supported:
- `.+(ly)` - a one or more match with grouping
- `word(s)` - a match with alternation at the end of a word
- `(word|letter)` - an alternation of words
## Testing
```bash
composer test
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
**Note:** Please make sure to update tests as appropriate.
## License
The MIT License (MIT). Please see the [License file](LICENSE.md) for more information.