Upload README.md

afe154c 8 months ago

No virus

15.1 kB

	---
	base_model: stockmark/stockmark-13b
	inference: false
	language:
	- ja
	library_name: transformers
	license: other
	model_creator: Stockmark Inc.
	model_name: Stockmark 13B
	model_type: llama
	pipeline_tag: text-generation
	prompt_template: '{prompt}

	'
	quantized_by: TheBloke
	tags:
	- japanese
	- llama-2
	---
	<!-- markdownlint-disable MD041 -->

	<!-- header start -->
	<!-- 200823 -->
	<div style="width: auto; margin-left: auto; margin-right: auto">
	<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
	</div>
	<div style="display: flex; justify-content: space-between; width: 100%;">
	<div style="display: flex; flex-direction: column; align-items: flex-start;">
	<p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
	</div>
	<div style="display: flex; flex-direction: column; align-items: flex-end;">
	<p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
	</div>
	</div>
	<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
	<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
	<!-- header end -->

	# Stockmark 13B - AWQ
	- Model creator: [Stockmark Inc.](https://huggingface.co/stockmark)
	- Original model: [Stockmark 13B](https://huggingface.co/stockmark/stockmark-13b)

	<!-- description start -->
	## Description

	This repo contains AWQ model files for [Stockmark Inc.'s Stockmark 13B](https://huggingface.co/stockmark/stockmark-13b).

	These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).


	### About AWQ

	AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.

	It is supported by:

	- [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
	- [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
	- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
	- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code

	<!-- description end -->
	<!-- repositories-available start -->
	## Repositories available

	* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/stockmark-13B-AWQ)
	* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/stockmark-13B-GPTQ)
	* [Stockmark Inc.'s original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/stockmark/stockmark-13b)
	<!-- repositories-available end -->

	<!-- prompt-template start -->
	## Prompt template: None

	```
	{prompt}

	```

	<!-- prompt-template end -->


	<!-- README_AWQ.md-provided-files start -->
	## Provided files, and AWQ parameters

	For my first release of AWQ models, I am releasing 128g models only. I will consider adding 32g as well if there is interest, and once I have done perplexity and evaluation comparisons, but at this time 32g models are still not fully tested with AutoAWQ and vLLM.

	Models are released as sharded safetensors files.

	\| Branch \| Bits \| GS \| AWQ Dataset \| Seq Len \| Size \|
	\| ------ \| ---- \| -- \| ----------- \| ------- \| ---- \|
	\| [main](https://huggingface.co/TheBloke/stockmark-13B-AWQ/tree/main) \| 4 \| 128 \| japanese \| 2048 \| 7.62 GB

	<!-- README_AWQ.md-provided-files end -->

	<!-- README_AWQ.md-text-generation-webui start -->
	## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)

	Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/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.

	1. Click the Model tab.
	2. Under Download custom model or LoRA, enter `TheBloke/stockmark-13B-AWQ`.
	3. Click Download.
	4. The model will start downloading. Once it's finished it will say "Done".
	5. In the top left, click the refresh icon next to Model.
	6. In the Model dropdown, choose the model you just downloaded: `stockmark-13B-AWQ`
	7. Select Loader: AutoAWQ.
	8. Click Load, and the model will load and is now ready for use.
	9. 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.
	10. Once you're ready, click the Text Generation tab and enter a prompt to get started!
	<!-- README_AWQ.md-text-generation-webui end -->

	<!-- README_AWQ.md-use-from-vllm start -->
	## Multi-user inference server: vLLM

	Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).

	- Please ensure you are using vLLM version 0.2 or later.
	- When using vLLM as a server, pass the `--quantization awq` parameter.

	For example:

	```shell
	python3 python -m vllm.entrypoints.api_server --model TheBloke/stockmark-13B-AWQ --quantization awq
	```

	- When using vLLM from Python code, again set `quantization=awq`.

	For example:

	```python
	from vllm import LLM, SamplingParams

	prompts = [
	"Tell me about AI",
	"Write a story about llamas",
	"What is 291 - 150?",
	"How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
	]
	prompt_template=f'''{prompt}
	'''

	prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]

	sampling_params = SamplingParams(temperature=0.8, top_p=0.95)

	llm = LLM(model="TheBloke/stockmark-13B-AWQ", quantization="awq", dtype="auto")

	outputs = llm.generate(prompts, sampling_params)

	# Print the outputs.
	for output in outputs:
	prompt = output.prompt
	generated_text = output.outputs[0].text
	print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
	```
	<!-- README_AWQ.md-use-from-vllm start -->

	<!-- README_AWQ.md-use-from-tgi start -->
	## Multi-user inference server: Hugging Face Text Generation Inference (TGI)

	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:

	```shell
	--model-id TheBloke/stockmark-13B-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
	```

	Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):

	```shell
	pip3 install huggingface-hub
	```

	```python
	from huggingface_hub import InferenceClient

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

	prompt = "Tell me about AI"
	prompt_template=f'''{prompt}
	'''

	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)
	```
	<!-- README_AWQ.md-use-from-tgi end -->

	<!-- README_AWQ.md-use-from-python start -->
	## Inference from Python code using AutoAWQ

	### Install the AutoAWQ package

	Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.1 or later.

	```shell
	pip3 install autoawq
	```

	If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:

	```shell
	pip3 uninstall -y autoawq
	git clone https://github.com/casper-hansen/AutoAWQ
	cd AutoAWQ
	pip3 install .
	```

	### AutoAWQ example code

	```python
	from awq import AutoAWQForCausalLM
	from transformers import AutoTokenizer

	model_name_or_path = "TheBloke/stockmark-13B-AWQ"

	# Load tokenizer
	tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=False)
	# Load model
	model = AutoAWQForCausalLM.from_quantized(model_name_or_path, fuse_layers=True,
	trust_remote_code=False, safetensors=True)

	prompt = "Tell me about AI"
	prompt_template=f'''{prompt}
	'''

	print("*** Running model.generate:")

	token_input = tokenizer(
	prompt_template,
	return_tensors='pt'
	).input_ids.cuda()

	# Generate output
	generation_output = model.generate(
	token_input,
	do_sample=True,
	temperature=0.7,
	top_p=0.95,
	top_k=40,
	max_new_tokens=512
	)

	# Get the tokens from the output, decode them, print them
	token_output = generation_output[0]
	text_output = tokenizer.decode(token_output)
	print("LLM output: ", text_output)

	"""
	# Inference should be possible with transformers pipeline as well in future
	# But currently this is not yet supported by AutoAWQ (correct as of September 25th 2023)
	from transformers import 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'])
	"""
	```
	<!-- README_AWQ.md-use-from-python end -->

	<!-- README_AWQ.md-compatibility start -->
	## Compatibility

	The files provided are tested to work with:

	- [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
	- [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
	- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
	- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.

	<!-- README_AWQ.md-compatibility end -->

	<!-- footer start -->
	<!-- 200823 -->
	## Discord

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

	[TheBloke AI's Discord server](https://discord.gg/theblokeai)

	## Thanks, and how to contribute

	Thanks to the [chirper.ai](https://chirper.ai) team!

	Thanks to Clay from [gpus.llm-utils.org](llm-utils)!

	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: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius


	Thank you to all my generous patrons and donaters!

	And thank you again to a16z for their generous grant.

	<!-- footer end -->

	# Original model card: Stockmark Inc.'s Stockmark 13B


	# stockmark/stockmark-13b

	Stockmark-13b is a 13 billion parameter LLM pretrained from scratch based on Japanese corpus of about 220B tokens. This model is developed by [Stockmark Inc.](https://stockmark.co.jp/)

	Please see our [blog](https://tech.stockmark.co.jp/blog/202310_stockmark_13b/) for more details.

	This project is supported by [AWS LLM development support program](https://aws.amazon.com/jp/local/llm-development-support-program/).

	## How to use

	```python
	import torch
	from transformers import AutoModelForCausalLM, AutoTokenizer

	# For A100 or H100 GPU
	model = AutoModelForCausalLM.from_pretrained("stockmark/stockmark-13b", device_map="auto", torch_dtype=torch.bfloat16)

	# If you use a T4 or V100 GPU, please load a model in 8 bit with the below code.
	# To do so, you need to install `bitsandbytes` via `pip install bitsandbytes`.
	# model = AutoModelForCausalLM.from_pretrained("stockmark/stockmark-13b", device_map={"": 0}, load_in_8bit=True)

	tokenizer = AutoTokenizer.from_pretrained("stockmark/stockmark-13b")

	inputs = tokenizer("自然言語処理とは", return_tensors="pt").to(model.device)
	with torch.no_grad():
	tokens = model.generate(
	**inputs,
	max_new_tokens=128,
	do_sample=True,
	temperature=0.7
	)

	output = tokenizer.decode(tokens[0], skip_special_tokens=True)
	print(output)
	```

	## Examples:

	- LoRA tuning: https://huggingface.co/stockmark/stockmark-13b/blob/main/notebooks/LoRA.ipynb

	## Training dataset

	We have used Japanese corpus of total of about 220 billion tokens.

	\|corpus\|tokens after preprocessing\|
	\|:---:\|:---:\|
	\|Stockmark Web Corpus (This dataset will not be released)\|9.1 billion\|
	\|Patent\|34.8 billion\|
	\|Wikipedia\|1.0 billion\|
	\|CC100\|10.9 billion\|
	\|mC4\|53.2 billion\|
	\|CommonCrawl (snapshot: 2023-23, 2022-49, 2022-21, 2021-21)\|112.9 billion\|


	## Accelerator and Library
	- Accelerator: AWS Trainium
	- https://aws.amazon.com/machine-learning/trainium/
	- Library for distributed training: neuronx-nemo-megatron
	- https://github.com/aws-neuron/neuronx-nemo-megatron

	## License
	[MIT](https://opensource.org/licenses/MIT)

	## Developed by
	[Stockmark Inc.](https://stockmark.co.jp/)

	## Author
	[Takahiro Omi](https://huggingface.co/omitakahiro)