Chat & support: TheBloke's Discord server

Want to contribute? TheBloke's Patreon page

TheBloke's LLM work is generously supported by a grant from andreessen horowitz (a16z)

Inkbot 13B 8K 0.2 - GPTQ

Model creator: Adam Brusselback
Original model: Inkbot 13B 8K 0.2

Description

This repo contains GPTQ model files for Adam Brusselback's Inkbot 13B 8K 0.2.

Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.

Repositories available

Prompt template: Inkbot

<#meta#>
- Date: [DATE]
- Task: [TASK TYPE]
<#system#>
{system_message}
<#chat#>
<#user#>
{prompt}
<#bot#>

Provided files, and GPTQ parameters

Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.

Each separate quant is in a different branch. See below for instructions on fetching from different branches.

Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.

Explanation of GPTQ parameters

Bits: The bit size of the quantised model.
GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
Act Order: True or False. Also known as desc_act. True results in better quantisation accuracy. Some GPTQ clients have had issues with models that use Act Order plus Group Size, but this is generally resolved now.
Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
GPTQ dataset: The calibration dataset used during quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ calibration dataset is not the same as the dataset used to train the model - please refer to the original model repo for details of the training dataset(s).
Sequence Length: The length of the dataset sequences used for quantisation. Ideally this is the same as the model sequence length. For some very long sequence models (16+K), a lower sequence length may have to be used. Note that a lower sequence length does not limit the sequence length of the quantised model. It only impacts the quantisation accuracy on longer inference sequences.
ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.

Branch	Bits	GS	Act Order	Damp %	GPTQ Dataset	Seq Len	Size	ExLlama	Desc
main	4	128	Yes	0.1	wikitext	8192	7.26 GB	Yes	4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy.
gptq-4bit-32g-actorder_True	4	32	Yes	0.1	wikitext	8192	8.00 GB	Yes	4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage.
gptq-8bit--1g-actorder_True	8	None	Yes	0.1	wikitext	8192	13.36 GB	No	8-bit, with Act Order. No group size, to lower VRAM requirements.
gptq-8bit-128g-actorder_True	8	128	Yes	0.1	wikitext	8192	13.65 GB	No	8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy.
gptq-8bit-32g-actorder_True	8	32	Yes	0.1	wikitext	8192	14.55 GB	No	8-bit, with group size 32g and Act Order for maximum inference quality.
gptq-4bit-64g-actorder_True	4	64	Yes	0.1	wikitext	8192	7.51 GB	Yes	4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy.

How to download, including from branches

In text-generation-webui

To download from the main branch, enter TheBloke/Inkbot-13B-8k-0.2-GPTQ in the "Download model" box.

To download from another branch, add :branchname to the end of the download name, eg TheBloke/Inkbot-13B-8k-0.2-GPTQ:gptq-4bit-32g-actorder_True

From the command line

I recommend using the huggingface-hub Python library:

pip3 install huggingface-hub

To download the main branch to a folder called Inkbot-13B-8k-0.2-GPTQ:

mkdir Inkbot-13B-8k-0.2-GPTQ
huggingface-cli download TheBloke/Inkbot-13B-8k-0.2-GPTQ --local-dir Inkbot-13B-8k-0.2-GPTQ --local-dir-use-symlinks False

To download from a different branch, add the --revision parameter:

mkdir Inkbot-13B-8k-0.2-GPTQ
huggingface-cli download TheBloke/Inkbot-13B-8k-0.2-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Inkbot-13B-8k-0.2-GPTQ --local-dir-use-symlinks False

More advanced huggingface-cli download usage

If you remove the --local-dir-use-symlinks False parameter, the files will instead be stored in the central Huggingface cache directory (default location on Linux is: ~/.cache/huggingface), and symlinks will be added to the specified --local-dir, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.

The cache location can be changed with the HF_HOME environment variable, and/or the --cache-dir parameter to huggingface-cli.

For more documentation on downloading with huggingface-cli, please see: HF -> Hub Python Library -> Download files -> Download from the CLI.

To accelerate downloads on fast connections (1Gbit/s or higher), install hf_transfer:

pip3 install hf_transfer

And set environment variable HF_HUB_ENABLE_HF_TRANSFER to 1:

mkdir Inkbot-13B-8k-0.2-GPTQ
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Inkbot-13B-8k-0.2-GPTQ --local-dir Inkbot-13B-8k-0.2-GPTQ --local-dir-use-symlinks False

Windows Command Line users: You can set the environment variable by running set HF_HUB_ENABLE_HF_TRANSFER=1 before the download command.

With `git` (not recommended)

To clone a specific branch with git, use a command like this:

git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Inkbot-13B-8k-0.2-GPTQ

Note that using Git with HF repos is strongly discouraged. It will be much slower than using huggingface-hub, and will use twice as much disk space as it has to store the model files twice (it stores every byte both in the intended target folder, and again in the .git folder as a blob.)

How to easily download and use this model in text-generation-webui

Please make sure you're using the latest version of text-generation-webui.

It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.

Click the Model tab.
Under Download custom model or LoRA, enter TheBloke/Inkbot-13B-8k-0.2-GPTQ.
- To download from a specific branch, enter for example TheBloke/Inkbot-13B-8k-0.2-GPTQ:gptq-4bit-32g-actorder_True
- see Provided Files above for the list of branches for each option.
Click Download.
The model will start downloading. Once it's finished it will say "Done".
In the top left, click the refresh icon next to Model.
In the Model dropdown, choose the model you just downloaded: Inkbot-13B-8k-0.2-GPTQ
The model will automatically load, and is now ready for use!
If you want any custom settings, set them and then click Save settings for this model followed by Reload the Model in the top right.
- Note that you do not need to and should not set manual GPTQ parameters any more. These are set automatically from the file quantize_config.json.
Once you're ready, click the Text Generation tab and enter a prompt to get started!

Serving this model from Text Generation Inference (TGI)

It's recommended to use TGI version 1.1.0 or later. The official Docker container is: ghcr.io/huggingface/text-generation-inference:1.1.0

Example Docker parameters:

--model-id TheBloke/Inkbot-13B-8k-0.2-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096

Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):

pip3 install huggingface-hub

from huggingface_hub import InferenceClient

endpoint_url = "https://your-endpoint-url-here"

prompt = "Tell me about AI"
prompt_template=f'''<#meta#>
- Date: [DATE]
- Task: [TASK TYPE]
<#system#>
{system_message}
<#chat#>
<#user#>
{prompt}
<#bot#>
'''

client = InferenceClient(endpoint_url)
response = client.text_generation(prompt,
                                  max_new_tokens=128,
                                  do_sample=True,
                                  temperature=0.7,
                                  top_p=0.95,
                                  top_k=40,
                                  repetition_penalty=1.1)

print(f"Model output: {response}")

How to use this GPTQ model from Python code

Install the necessary packages

Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.

pip3 install transformers optimum
pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/  # Use cu117 if on CUDA 11.7

If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:

pip3 uninstall -y auto-gptq
git clone https://github.com/PanQiWei/AutoGPTQ
cd AutoGPTQ
git checkout v0.4.2
pip3 install .

You can then use the following code

from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline

model_name_or_path = "TheBloke/Inkbot-13B-8k-0.2-GPTQ"
# To use a different branch, change revision
# For example: revision="gptq-4bit-32g-actorder_True"
model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
                                             device_map="auto",
                                             trust_remote_code=False,
                                             revision="main")

tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)

prompt = "Tell me about AI"
prompt_template=f'''<#meta#>
- Date: [DATE]
- Task: [TASK TYPE]
<#system#>
{system_message}
<#chat#>
<#user#>
{prompt}
<#bot#>
'''

print("\n\n*** Generate:")

input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
print(tokenizer.decode(output[0]))

# Inference can also be done using transformers' pipeline

print("*** Pipeline:")
pipe = pipeline(
    "text-generation",
    model=model,
    tokenizer=tokenizer,
    max_new_tokens=512,
    do_sample=True,
    temperature=0.7,
    top_p=0.95,
    top_k=40,
    repetition_penalty=1.1
)

print(pipe(prompt_template)[0]['generated_text'])

Compatibility

The files provided are tested to work with AutoGPTQ, both via Transformers and using AutoGPTQ directly. They should also work with Occ4m's GPTQ-for-LLaMa fork.

ExLlama is compatible with Llama and Mistral models in 4-bit. Please see the Provided Files table above for per-file compatibility.

Huggingface Text Generation Inference (TGI) is compatible with all GPTQ models.

Discord

For further support, and discussions on these models and AI in general, join us at:

TheBloke AI's Discord server

Thanks, and how to contribute

Thanks to the chirper.ai team!

Thanks to Clay from gpus.llm-utils.org!

I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.

If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.

Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.

Patreon: https://patreon.com/TheBlokeAI
Ko-Fi: https://ko-fi.com/TheBlokeAI

Special thanks to: Aemon Algiz.

Patreon special mentions: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski

Thank you to all my generous patrons and donaters!

And thank you again to a16z for their generous grant.

Original model card: Adam Brusselback's Inkbot 13B 8K 0.2

Model Card for Inkbot

Model Details

Inkbot is a conversational AI model designed to interpret and respond to structured prompts with or without contextual information. Its unique feature lies in the structured prompt system, allowing users to engage in dynamic dialogues that can evolve based on context, metadata, and user input.

Performance

The model excels in RAG type queries, answering from context, and overriding memory when necessary.
It can handle very large contexts, but may sometimes enter a repeating text loop, especially during complex tasks.
The model is intended to be more functional and less chatty, avoiding the waste of tokens on superfluous language.

How to Use

Inkbot uses a structured prompt template system.

Prompt Template Structure

With Context:

<#meta#>
- Date: {current_date}
- Task: {task_name}
<#system#>
{system_prompt}
<#chat#>
<#user#>
{user}
<#user_context#>
{user_context}
<#bot#>
{bot}

Without Context:

<#meta#>
- Date: {current_date}
- Task: {task_name}
<#system#>
{system_prompt}
<#chat#>
<#user#>
{user}
<#bot#>
{bot}

Examples

With Context:

<#meta#>
- Date: 2023-07-20
- Task: general
<#system#>
A dialogue focused on determining dates based on context clues.
<#chat#>
<#user#>
What is today's date?
<#bot#>
The date is: 2023-07-20
<#user#>
When did the event in the provided context take place?
<#user_context#>
It's the day after new years eve, and I'm starting 2018 with a headache.
<#bot#>
The event in the context took place on: 2018-01-01

Without Context:

<#meta#>
- Date: 2023-07-20
- Task: general
<#system#>
A simple dialogue about daily queries.
<#chat#>
<#user#>
Will it rain today?
<#bot#>
I am not sure, without knowing your location I am unable to determine the weather.
<#user#>
Can you compose a haiku for me?
<#bot#>
Whispers of the breeze,
Nature's melodies unfold,
Dawn dispels the night.

Task Options

The model has been trained on a variety of tasks. Below is a breakdown of these tasks, along with example prompts to help guide your usage.

2. Content Generation

Tasks in this category involve creating or expanding content.

kg_writer (800 examples)

Example Prompts:

"Using the provided knowledge graph, write an article about the topics and entities in the graph, incorporating the linked ideas. Use idea tags while writing to help focus."
"Construct a story based on the information in the knowledge graph."

summary (1,600 examples)

Example Prompts:

"Generate an extensive summary of the given document."
"Please read the provided document to understand the context and content. Use this understanding to generate a summary. Separate the article into chunks, and sequentially create a summary for each chunk. Give me a final summary in the end."

paraphrase (1,100 examples)

Example Prompts:

"Rephrase the following sentence while retaining its original meaning."
"Can you provide an alternative wording for the paragraph below?"

3. Content Analysis

Tasks in this category evaluate, grade, or filter content.

grading (400 examples)

Example Prompts:

"Based on the provided document, please rate the usefulness as training data on a scale from 0-5."

sponsorblock (5,200 examples)

Example Prompts:

"Read the document and extract any sentences or phrases that contain explicit mentions of sponsorship, promotional partnerships, or any form of paid content."

4. Information Structuring

Tasks in this category involve the structured representation or extraction of information.

kg (3,600 examples)

Example Prompts:

"Create a Knowledge Graph from the document provided."
"Extract key concepts and relationships from the conversation to form a knowledge graph."

5. General Interaction

Tasks in this category are designed for general questions and interactions.

general (1,600 examples)

Example Prompts:

"What is the capital of France?"
"Explain particle physics to a 5 years old."

Limitations

Adhere to the prompt structure for best results.
When providing contextual details, clarity is essential for Inkbot to derive accurate and meaningful responses.
The overriding memory from user_context property generally only works for the next prompt or two, after which the model reverts to its original behavior.
On complex tasks, like creating a coherent story based on a set of facts from context, there's a potential for a repeating text loop as context fills.
Sometimes the model doesn't know when to end a knowledge graph, which can result in adding nodes and edges until it runs out of context.

Additional Notes

Use rope-freq-scale=0.5 or compress_pos_emb=2 for 8k ctx
The 'date', 'task', and 'system' are crucial metadata components that need to be provided outside the core dialogue.
Use the 'user_context' when you want to offer supplementary context that guides Inkbot's response. You can interleave it in the chat log as necessary. It comes after the users instruction.
The specific tag format, such as <#word#>, is used to because there are filters in a lot of APIs for <|word|> and this makes interactions easier.

Inkbot 13B 8K 0.2 - GPTQ

Description

Repositories available

Prompt template: Inkbot

Provided files, and GPTQ parameters

How to download, including from branches

In text-generation-webui

From the command line

With git (not recommended)

How to easily download and use this model in text-generation-webui

Serving this model from Text Generation Inference (TGI)

How to use this GPTQ model from Python code

Install the necessary packages

You can then use the following code

Compatibility

Discord

Thanks, and how to contribute

Original model card: Adam Brusselback's Inkbot 13B 8K 0.2

Model Card for Inkbot

Model Details

Performance

How to Use

Prompt Template Structure

With Context:

Without Context:

Examples

With Context:

Without Context:

Task Options

2. Content Generation

kg_writer (800 examples)

summary (1,600 examples)

paraphrase (1,100 examples)

3. Content Analysis

grading (400 examples)

sponsorblock (5,200 examples)

4. Information Structuring

kg (3,600 examples)

5. General Interaction

general (1,600 examples)

Limitations

Additional Notes

license: llama2

Model tree for TheBloke/Inkbot-13B-8k-0.2-GPTQ

With `git` (not recommended)