/margopher

Random Text Generator

Primary LanguageGoMIT LicenseMIT

MarGopher

Markov chain random text generator

How it Works

TL;DR You give it some text, it gives you a random (and sane) chunk out of this text.

Basically MarGopher is based on Markov chain statistical model, except that it starts by choosing a random prefix from the states dictionary to ensure more randomness.

It starts by parsing the input text and putting it into states dictionary then starts generating the output sentence.

The generator will keep generating words till it encounters a terminal word (a word that ends in '.')

States is a map contains prefix as keys and suffix as values.

Prefix is an array of two consecutive words from the original text.

Suffix is a slice of all the words that occur after a given prefix.

Installation

go get github.com/aasare/margopher

Usage

  1. Import the package
import "github.com/aasare/margopher"
  1. Create new margopher object
m := margopher.New()
  1. Read input text using one of three parsing methods:
  • ReadText(text string)
text := "I love cats. Cats love pizza."
fmt.Println(m.ReadText(text))
  • ReadFile(filePath string)
filePath := "../file.txt"
fmt.Println(m.ReadFile(filePath))
  • ReadURL(url string)
url := "https://github.com/AhmedZaleh/margopher"
fmt.Println(m.ReadURL(url))
  1. You can see the input parsed into a dictionary of States using ReadDictionary():
  • It returns a dicitonary of this signature map[[2]string][]string.
  • The words are unordered because Go maps do not keep order.
fmt.Println(m.ReadDictionary())

REST API

To use the API, add the following:

func main() {
  // Create New margopher
  m := margopher.New()

  // Call the Api() function
  m.Api()
}

Then send POST reqeusts to http://localhost:7878/ using one of these paths:

  • /readtext
  • /readfile
  • /readurl

Example

$ curl -d '"We eat sushi. They eat pasta."' http://localhost:7878/readtext

Feedback

I wrote this simple project particularly to learn Go so any feedback is more than welcome. If you have any, please open an issue or send a pull request.

License

See LICENSE.