Updated documentations

DavidBelicza · Dec 29, 2023 · d63788f · d63788f
1 parent b8a630c
commit d63788f
Show file tree

Hide file tree

Showing 17 changed files with 53 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -18,39 +18,42 @@ TextRank
 </p>
 
 <p align="center">
-This source code is an implementation of the TextRank algorithm (Automatic summarization) on PHP7 strict mode. It can summarize a text, article for example to a short paragraph. Before it would start the summarizing it removes the junk words what are defined in the Stopwords namespace. It is possible to extend it with another languages.
-<br />
+This source code is an implementation of TextRank algorithm in PHP programming language, under MIT licence.<br />
 <br />
 </p>
 
-## TextRank or Automatic summarization
+# TextRank vs. ChatGPT
+GPTs like ChatGPT are supervised language models that understand the context and generate new content from the given
+input using vast resources while TextRank is a cost-efficient/low-cost text extraction algorithm. TextRank algorithm 
+also can be used as a pre-processor to a GPT model to reduce the text size to save on resource consumption.
+
+# TextRank or Automatic summarization
 > Automatic summarization is the process of reducing a text document with a computer program in order to create a summary that retains the most important points of the original document. Technologies that can make a coherent summary take into account variables such as length, writing style and syntax. Automatic data summarization is part of machine learning and data mining. The main idea of summarization is to find a representative subset of the data, which contains the information of the entire set. Summarization technologies are used in a large number of sectors in industry today. - Wikipedia
 
 The algorithm of this implementation is:
-* Find sentences,
-* Remove stopwords,
-* Create integer values by find and count the matching words,
-* Change the integer values by the related words' integer values,
-* Normalize values to create scores,
-* Order by scores
-
-## Install
+* Extracts sentences,
+* Removes stopwords,
+* Adds integer values to words by finding and counting the matching words,
+* Weights the values of the words,
+* Normalizes values to get the scores,
+* Sorts by scores
+
+# Install to use it in your project
 ```
+cd your-project-folder
 composer require php-science/textrank
 ```
 
-## Test
+# Install for contributing
 ```
-cd project-folder
+cd git-project-folder
+docker-compose build
+docker-compose up -d
+composer install
 composer test
 ```
-or
-```
-cd project-folder
-phpunit --colors='always' $(pwd)/tests
-```
 
-## Examples
+# Examples
 ```php
 
 use PhpScience\TextRank\Tool\StopWords\English;
@@ -73,10 +76,10 @@ $result = $api->getHighlights($text);
 $result = $api->summarizeTextBasic($text);
 ```
 More examples: 
-* [tests/TextRankFacadeTest.php](https://github.com/DoveID/PHP-Science-TextRank/blob/master/tests/TextRankFacadeTest.php)
+* [tests/TextRankFacadeTest.php](https://github.com/DavidBelicza/PHP-Science-TextRank/blob/master/tests/TextRankFacadeTest.php)
 * https://php.science
 
-## Authors, Contributors
+# Authors, Contributors
 
 Name | GitHub user
 --- | ---
@@ -89,3 +92,5 @@ Andrey Astashov | @mvcaaa
 Leo Toneff | @bragle
 Willy Arisky | @willyarisky
 Robert-Jan Keizer | @KeizerDev
+Morty | @evil1morty
+Sezer Fidancı | @SezerFidanci
diff --git a/phpunit.xml b/phpunit.xml
@@ -3,9 +3,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 -->
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

diff --git a/src/TextRankFacade.php b/src/TextRankFacade.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/Graph.php b/src/Tool/Graph.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/Parser.php b/src/Tool/Parser.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/Score.php b/src/Tool/Score.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/StopWords/English.php b/src/Tool/StopWords/English.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/StopWords/French.php b/src/Tool/StopWords/French.php
@@ -2,7 +2,7 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
  * @author  Syndesi <github.com/Syndesi>
  */

diff --git a/src/Tool/StopWords/German.php b/src/Tool/StopWords/German.php
@@ -2,7 +2,7 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
  * @author  Syndesi <github.com/Syndesi>
  */

diff --git a/src/Tool/StopWords/Norwegian.php b/src/Tool/StopWords/Norwegian.php
@@ -2,7 +2,7 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
  * @author  Syndesi <github.com/Syndesi>
  */

diff --git a/src/Tool/StopWords/Russian.php b/src/Tool/StopWords/Russian.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  * @author  Andrey Astashov <mvc.aaa@gmail.com> (Russian StopWords)
  */
 

diff --git a/src/Tool/StopWords/Spanish.php b/src/Tool/StopWords/Spanish.php
@@ -2,7 +2,7 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
  * @author  Syndesi <github.com/Syndesi>
  */

diff --git a/src/Tool/StopWords/StopWordsAbstract.php b/src/Tool/StopWords/StopWordsAbstract.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/StopWords/Turkish.php b/src/Tool/StopWords/Turkish.php
@@ -2,7 +2,7 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
  * @author  Sezer Fidancı <github.com/SezerFidanci>
  */

diff --git a/src/Tool/Summarize.php b/src/Tool/Summarize.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/src/Tool/Text.php b/src/Tool/Text.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);

diff --git a/tests/TextRankFacadeTest.php b/tests/TextRankFacadeTest.php
@@ -2,9 +2,9 @@
 /**
  * PHP Science TextRank (http://php.science/)
  *
- * @see     https://github.com/doveid/php-science-textrank
+ * @see     https://github.com/DavidBelicza/PHP-Science-TextRank
  * @license https://opensource.org/licenses/MIT the MIT License
- * @author  David Belicza <87.bdavid@gmail.com>
+ * @author  David Belicza <david@belicza.com>
  */
 
 declare(strict_types=1);