Skip to content

Usage should be added to docs #2

@accraze

Description

@accraze

The file docs/usage.rst should be filled out with some basic information. Maybe something like:

This module (ia_markov) allows you to train a Markov model with text files from the Internet Archive. To download text files, simply find the slug located in the Internet Archive URL and pass it to MarkovModel.train_model. This will automatically download the text to your current working directory and then train a model on the downloaded text file.

For example:

If we wanted to download the text from https://archive.org/details/FuturistManifesto/page/n0

We pass the slug (FuturistManifesto) to the our model and if there is a text file, it will be downloaded and trained on.

from ia_markov import MarkovModel

m = MarkovModel()
ia_slug = ''FuturistManifesto'
m.train_model(slug)
m.model.make_sentence()
'Courage, audacity, and revolt will be drunk with love and admiration for us.'

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions