luciangreen / essay-helper

Uses KNN to help write an essay.

Essay Helper | Text-to-Breasonings (Helps Earn High Distinctions) | Grammar Logic (Helps Mind Map Details)

Essay Helper

• Important: Manually check the page references after using Essay Helper.

• Remove page references when not a direct quote in APA.

• Uses KNN to help write essays. Asks for 5 paragraphs of N reasons per paragraph of exposition and critique. Has a positivity detector (must be positive in whole essay apart from either only positive or negative in critique comments). Uses K-Nearest-Neighbour algorithm to check quotes, comments and connections are relevant.

• You should use a word frequency tool to find viable keywords. You may need to redraft after reading to find better keywords.

• Think of the "number one way of thinking" before running any mind reading algorithm for more understandable results.

• Run sheet feeder with swipl --stack_limit=2G, one file at a time and quitting swipl between attempts for better results.

• short_essay_helper.pl - the Essay Helper algorithm

• distances.pl - the KNN algorithm

• file.txt - the essay to write the essay on

• walk_through.txt - example walkthrough of the algorithm (no output)

• short_essay_helper2.pl - the Essay Helper without paraphrasing checking, and outputs an HTML essay with ordered bibliography.

• short_essay_helper3_agps.pl - the Essay Helper generates random essays from a number of sources without paraphrasing checking, and outputs an HTML essay with ordered bibliography.

• short_essay_helper3.1_agps.pl - Like Essay Helper 3, but finds sentences containing any keywords given.

• short_essay_helper3.1_agps-mr.pl - same as short_essay_helper3.1.pl but uses mind reader.

• short_essay_helper3.1_chicago.pl - same as short_essay_helper3.1_agps.pl, but in Chicago style (with Ibid).

• source_tagger.pl - Helps tag and report tags similarly to nVivo.

• short_essay_helper3.1_agps-mr-tree.pl - same as short_essay_helper3.1.pl but uses mind reader with a character tree. It is slow.

Getting Started

Please read the following instructions on how to install the project on your computer for helping write essays.

Prerequisites

• Please download and install SWI-Prolog for your machine at https://www.swi-prolog.org/build/.

1. Install manually

Download this repository, List Prolog Interpreter Repository, and Mind Reader Repository.

2. Or Install from List Prolog Package Manager (LPPM)

• Download the LPPM Repository:

mkdir GitHub
cd GitHub/
git clone https://github.com/luciangreen/List-Prolog-Package-Manager.git
cd List-Prolog-Package-Manager
swipl
['lppm'].
lppm_install("luciangreen","Essay-Helper").
halt

Running Essay Helper

• In Shell: cd Essay-Helper swipl

• Load with ['short_essay_helper.pl'].

• In swipl, run with:

short_essay_helper("file.txt",5).

about essay "file.txt" for 5 reasons per paragraph.

• To change the number of paragraphs in the exposition of the essay, edit 5 in

length(List1,5), %% 5->1 paragraphs per exposition

in the correct Essay Helper algorithm file.

• To change the number of paragraphs in the critique of the essay, edit 5 in

length(List1,5), %% 5->1 paragraphs per critique

in the correct Essay Helper algorithm file.

• See walk-through as an example of Essay Helper.

Installing and Running Essay Helper 2

• Essay Helper 2 outputs the essay and the essay in HTML form, with ordered references and argument traversed depth first.

• Install by downloading the prerequisites above and saving in folders next to each other or by using LPPM above.

• Run swipl

• Load with ['short_essay_helper2.pl'].

• In swipl, run with:

short_essay_helper("Author's Heading",5).

with heading of the essay, "Author's Heading" and 5 reasons per paragraph.

• See walk-through2, walk_through2.html and walk_through2-output.txt as examples of Essay Helper 2.

Installing and Running Essay Helper 3 - Random Essay Generator - AGPS Referencing

• Essay Helper 3 randomly outputs the essay and the essay in HTML form, with ordered references and argument traversed depth first.

• Note: Generated essays are not to be handed in, and you need to paraphrase and cite work you have referenced. Your grade depends on whether you agree or disagree and how many breasonings you breason out. Check the referencing style is appropriate for your class (this algorithm uses AGPS style).

• Install by downloading the prerequisites above and saving in folders next to each other or by using LPPM above.

• Run swipl

• Load with ['short_essay_helper3_agps.pl'].

• In the raw_sources folder, place text files for the essay sources with the names "*.txt", etc., and two newlines between pages.

• Run sheet_feeder(_). to convert the files in raw_sources and save them in sources.

• Check the new source files in the sources folder are in the format:

["Surname, A 2000, <i>Title: Subtitle</i>, Publisher, City.","Surname, A 2000",1,"<first page>","<second page>",...]

• Insert the first item, the reference for the source, in the required referencing style in double quotes, insert the part of the in-text reference as the second item, insert the first page number of the paper from the source as the third item and check the pages are separated in double quotes as above. You should remove headers, etc. from each page so that they are not used in the essay. For this version, move ends of sentences over pages onto the first page.
• In swipl, run with:

short_essay_helper("Author's Heading",5).

with heading of the essay, "Author's Heading" and 5 reasons per paragraph.

• See walk_through3.html as an example of Essay Helper 3.

Installing and Running Essay Helper 3.1 - Essay Generator with Relevance - AGPS Referencing - And Mind Reading

• Essay Helper 3 outputs the essay and the essay in HTML form, with ordered references and argument traversed depth first, with key words, any of which to search for in each sentence. Chooses sources, pages and quotes in order (or vaguely mind read in random order). Quotes are not repeated.

• Note: Generated essays are not to be handed in, and you need to paraphrase and cite work you have referenced. Your grade depends on whether you agree or disagree and how many breasonings you breason out. Check the referencing style is appropriate for your class (this algorithm uses AGPS style).

• Install by downloading the prerequisites above and saving in folders next to each other or by using LPPM above.

• Run swipl

• Load with ['short_essay_helper3.1_agps.pl']. or ['short_essay_helper3.1_agps-mr.pl']. (['short_essay_helper3.1_agps-mr-tree.pl']. - mind reads character by character). for mind reading mode (It detects vague, not exact thoughts. Before running texttobr (in mind reader), think of two radio buttons put on recordings, put through with prayer, nut and bolt, quantum box prayer 1, 1, 0.5 cm and 1, 1, 0.5 cm. Follow instructions in Instructions for initialising Mind Reader and Instructions for Using texttobr(2) when using texttobr, texttobr2 or mind reader to avoid medical problems.).

• In the raw_sources folder, place text files for the essay sources with the names "*.txt", etc., and two newlines between pages.

• Run sheet_feeder(_). to convert the files in raw_sources and save them in sources.

• Check the new source files in the sources folder are in the format:

["Surname, A 2000, <i>Title: Subtitle</i>, Publisher, City.","Surname, A 2000",1,"<first page>","<second page>",...]

• Insert the first item, the reference for the source, in the required referencing style in double quotes, insert the part of the in-text reference as the second item, insert the first page number of the paper from the source as the third item and check the pages are separated in double quotes as above. You should remove headers, etc. from each page so that they are not used in the essay. For this version, move ends of sentences over pages onto the first page.
• In swipl, run with:

short_essay_helper("Author's Heading",["critical","evaluation"],5).

with heading of the essay, "Author's Heading", keywords "critical" and "evaluation" and 5 reasons per paragraph.

• See walk_through3.1.html as an example of Essay Helper 3.1.

Installing and Running Essay Helper 3.1 - Essay Generator with Relevance - Chicago Style

• Essay Helper 3 outputs the essay and the essay in HTML form, with ordered endnotes and references and argument traversed depth first, with key words, any of which to search for in each sentence. Chooses sources, pages and quotes in order. Quotes are not repeated.

• Note: Generated essays are not to be handed in, and you need to paraphrase and cite work you have referenced. Your grade depends on whether you agree or disagree and how many breasonings you breason out. Check the referencing style is appropriate for your class (this algorithm uses Chicago style).

• Install by downloading the prerequisites above and saving in folders next to each other or by using LPPM above.

• Run swipl

• Load with ['short_essay_helper3.1_chicago.pl'].

• In the raw_sources folder, place text files for the essay sources with the names "*.txt", etc., and two newlines between pages.

• Run sheet_feeder(_). to convert the files in raw_sources and save them in sources.

• Check the new source files in the sources folder are in the format:

["Surname, A 2000, <i>Title: Subtitle</i>, Publisher, City.","Surname, A 2000",1,"<first page>","<second page>",...]

• Insert the first item, the reference for the source, in the required referencing style in double quotes, insert the part of the in-text reference as the second item, insert the first page number of the paper from the source as the third item and check the pages are separated in double quotes as above. You should remove headers, etc. from each page so that they are not used in the essay. For this version, move ends of sentences over pages onto the first page.
• In swipl, run with:

short_essay_helper("Author's Heading",["critical","evaluation"],5).

with heading of the essay, "Author's Heading", keywords "critical" and "evaluation" and 5 reasons per paragraph.

• See walk_through3.1-chicago.html as an example of Essay Helper 3.1-Chicago.

Installing and Running Source Tagger

• Source Tagger tags quotes and sources with multiple tags and reports the quotes and sources for a particular tag.

• Install by downloading the prerequisites above and saving in folders next to each other or by using LPPM above.

• For a new set of tags, create a new tags.txt file in the directory containing [].

• Run swipl

• Load with ['short_essay_helper3.1_chicago.pl']. ['source_tagger.pl'].

• Run with source_tagger.

?- source_tagger.
New tag? (y/n)
|: y
What are the tags?
|: a
What is the text?
|: abc
What is the source?
|: ref abc
New tag? (y/n)
|: n
true.

• Enter the tags, text and source for each set of tags.

• Print the report of a tag with print_tags.

?- print_tags.
a
b
e
f
Enter tag to show report of.
|: a
c
d

z
p

abc
ref abc

true.

• Enter the tag name to print text and source for each tag with that name.

Details for Marks and Meeting Requirements

• Text to Breasonings is required to breason out essays for high distinctions.
• Grammar and Logic to Algorithm, in the Algorithm Writer with Lists Repository is needed to generate 30 As=2400 words in Honours from hand-written 80 philosophy breasonings (100 As in Master=8000 words, 400 As in PhD=32000 words).
• (NB. Phil2Alg may not produce original algorithms needed.) Phil2Alg, in the Philosophy Repository is needed to generate details (20 words per sentence in an Honours thesis, 30 in Master in 50 in PhD) before using Grammar and Logic to Algorithm.

Authors

Lucian Green - Initial programmer - Lucian Academy

License

I licensed this project under the BSD3 License - see the LICENSE.md file for details