GPTAuthor is a tool for writing long form stories using AI
Project description
GPT Author
GPTAuthor is a tool for writing long form, multi-chapter stories and novels using AI
Installation
You can install gptauthor using pip:
pip install gptauthor
Usage
Example Usage
This example reads the story prompt from the example file prompts-openai-drama.yaml file and writes 3 chapters using the gpt-3.5-turbo
model with a temperature of 0.1
:
export OPENAI_API_KEY=sk-<your key>
gptauthor --story prompts-openai-drama --total-chapters 3 --llm-model gpt-3.5-turbo --llm-temperature 0.1
Required Arguments
--story TEXT
: The name of the yaml file defining the story and prompts
Optional Arguments
--llm-model TEXT
: The model name [default: gpt-3.5-turbo]--llm-temperature FLOAT
: LLM temperature value (0 to 2, OpenAI default is 1) [default: 1]--llm-top-p FLOAT
: LLM top_p probability value (0 to 2, OpenAI default is 1) [default: 1]--llm-use-localhost INTEGER
: LLM use localhost:8081 instead of openai [default: 0]--total-chapters INTEGER
: Total chapters to write [default: 3]--allow-user-input / --no-allow-user-input
: Allow command line user input [default: allow-user-input]--version
: Display gptauthor version--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Produced Output Files
While running the app tells your the input paramers, the progress of the writing, and where the output is written to.
In progress and final output is written to the ./_output/
directory, in the sub-folders ./_output/<prompt-file-name>/<model-name>/<datetime>-<parameters>-<book-name>/
.
There are several files, the main output being a Markdown version of the whole book _whole_book.md
and an HTML version of the same _whole_book.html
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gptauthor-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ced6d06de3a36de8c78e3588ce155201f24aa5f7f94e50cc207a5e6635742dd4 |
|
MD5 | 2f87e263ade731fe3946968f4291799e |
|
BLAKE2b-256 | 3dd1467a37808523c6dc49f4a6ea1582d73d6e33a58fa4d28bc68c636cd93e66 |