mimic

package module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2020 License: MIT Imports: 3 Imported by: 1

README

Mimic

Documentation

This package exposes an easy to use interface to train Markov chains based on sentences you provide. You can generate sentences just as easily.

Getting Started

Install Mimic

go get github.com/colinfike/mimic

Generate a new MarkovChain object, passing in the minimum amount of words required in a training sentence for it to be processed.

markov := mimic.NewMarkovChain(4)

Train it with sentences.

markov.Train([]string{"Hello there Obi Wan", "Then he said hello there jon", "Obi Wan he said you wouldn't make it"})

Generate a sentence.

for i := 0; i < 10; i++ {
    fmt.Println(markov.Generate())
}

// then he said hello there obi wan he said hello there obi wan
// then he said you wouldn't make it
// obi wan he said hello there jon
// obi wan he said you wouldn't make it
// hello there jon
// hello there obi wan he said hello there jon
// obi wan he said you wouldn't make it
// obi wan he said hello there jon
// hello there jon
// hello there jon

Limitations

Currently this is in a limited v1.0 state. The only processing done on the input is downcasing everything. There could be undefined behavior with certain inputs. There is no weighting on how frequently a suffix occurs after a specific prefix, they are all weighted equal at the moment when generating a sentence. Currently delimited by spaces, not customizable at this time.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MarkovChain

type MarkovChain struct {
	// contains filtered or unexported fields
}

MarkovChain stores the markov chain and is the main interface into the package.

func NewMarkovChain

func NewMarkovChain(minWords int) *MarkovChain

NewMarkovChain returns a new MarkovChain that ignores any sentence passed to it with less than <minWords> words

func (*MarkovChain) Generate

func (m *MarkovChain) Generate() string

Generate returns a generated sentence from the Markov chain

func (*MarkovChain) Train

func (m *MarkovChain) Train(trainingText []string)

Train consumes the trainingText and updates the Markov chain accordingly

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL