Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / text-generation-inference /main /en /usage_statistics.html

rtrm

about 1 month ago

download

raw

18.6 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Collection of Usage Statistics","local":"collection-of-usage-statistics","sections":[{"title":"What data is collected","local":"what-data-is-collected","sections":[],"depth":2},{"title":"How to opt-out","local":"how-to-opt-out","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/text-generation-inference/main/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/entry/start.1810066f.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/scheduler.362310b7.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/singletons.fa2b0eb7.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/index.7f53ec41.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/paths.284aef40.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/entry/app.8cfc1931.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/index.57dfc70d.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/nodes/0.543c9bd9.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/nodes/35.4268715f.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/CodeBlock.d3c47f83.js">
	<link rel="modulepreload" href="/docs/text-generation-inference/main/en/_app/immutable/chunks/EditOnGithub.9633c464.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Collection of Usage Statistics","local":"collection-of-usage-statistics","sections":[{"title":"What data is collected","local":"what-data-is-collected","sections":[],"depth":2},{"title":"How to opt-out","local":"how-to-opt-out","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="collection-of-usage-statistics" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#collection-of-usage-statistics"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Collection of Usage Statistics</span></h1> <p data-svelte-h="svelte-2eqz6t">Text Generation Inference collects anonymous usage statistics to help us improve the service. The collected data is used to improve TGI and to understand what causes failures. The data is collected transparently and any sensitive information is omitted.</p> <p data-svelte-h="svelte-dsx48y">Data is sent twice, once on server startup and once when server stops. Also, usage statistics are only enabled when TGI is running in docker to avoid collecting data then TGI runs directly on the host machine.</p> <h2 class="relative group"><a id="what-data-is-collected" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#what-data-is-collected"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>What data is collected</span></h2> <p data-svelte-h="svelte-1ss2ebj">The code that collects the data is available <a href="https://github.com/huggingface/text-generation-inference/blob/main/router/src/usage_stats.rs" rel="nofollow">here</a>.
	As of release 2.1.2 this is an example of the data collected:</p> <ul data-svelte-h="svelte-1lhp668"><li>From the TGI configuration:</li></ul> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"event_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"start"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"disable_grammar_support"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">false</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_batch_prefill_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">4096</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_batch_size"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_batch_total_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_best_of"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">2</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_client_batch_size"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">4</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_concurrent_requests"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">128</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_input_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">1024</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_stop_sequences"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">4</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_top_n_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">5</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_total_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">2048</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"max_waiting_tokens"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">20</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"messages_api_enabled"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">false</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"model_config"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"model_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Bloom"</span>
	<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"revision"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"tokenizer_class"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"BloomTokenizerFast"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"validation_workers"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">2</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"waiting_served_ratio"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">1.2</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"docker_label"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"latest"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"git_sha"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"cfc118704880453d29bcbe4fbbd91dda501cf5fe"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"nvidia_env"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"NVIDIA A10G"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"pci_bus_id"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"00000000:00:1E.0"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"driver_version"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"535.183.01"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"pstate"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"P8"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"pcie_link_gen_max"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"4"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"pcie_link_gen_current"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"1"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"temperature_gpu"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"31"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"utilization_gpu"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"0 %"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"utilization_memory"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"0 %"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"memory_total"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"23028 MiB"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"memory_free"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"22515 MiB"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"memory_used"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"0 MiB"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"reset_status_reset_required"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"No"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"reset_status_drain_and_reset_recommended"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"No"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"compute_cap"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"8.6"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"ecc_errors_corrected_volatile_total"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"0"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"mig_mode_current"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"[N/A]"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"power_draw_instant"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"10.86 W"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"power_limit"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"300.00 W"</span>
	<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"system_env"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"cpu_count"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">16</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"cpu_type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"AMD EPYC 7R32"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"total_memory"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">66681196544</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"architecture"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"x86_64"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"platform"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"linux-unix-x86_64"</span>
	<span class="hljs-punctuation">}</span>
	<span class="hljs-punctuation">}</span>
	<!-- HTML_TAG_END --></pre></div> <h2 class="relative group"><a id="how-to-opt-out" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#how-to-opt-out"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>How to opt-out</span></h2> <p data-svelte-h="svelte-1d05e6t">By passing the <code>--usage-stats</code> to the text-generation-launcher you can control how much usage statistics are being collected.
	<code>--usage-stats=no-stack</code> will not emit the stack traces from errors and the error types, but will continue to send start and stop events
	<code>--usage-stats=off</code> will completely disable everything</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/text-generation-inference/blob/main/docs/source/usage_statistics.md" target="_blank"><span data-svelte-h="svelte-1kd6by1"><</span> <span data-svelte-h="svelte-x0xyl0">></span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_1dfb6m4 = {
	assets: "/docs/text-generation-inference/main/en",
	base: "/docs/text-generation-inference/main/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/text-generation-inference/main/en/_app/immutable/entry/start.1810066f.js"),
	import("/docs/text-generation-inference/main/en/_app/immutable/entry/app.8cfc1931.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 35],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 18.6 kB
Xet hash:: 4112245975ed0d11d54671d5b3a9cda5a17e1b5f6e204962a8405758ef83f18b

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.