Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / autotrain /pr_749 /en /autotrain_api.html

rtrm

about 2 months ago

download

raw

11.4 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"AutoTrain API","local":"autotrain-api","sections":[{"title":"Getting Started","local":"getting-started","sections":[],"depth":2},{"title":"Example Usage","local":"example-usage","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/autotrain/pr_749/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/scheduler.0219f8bd.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/singletons.74a96c49.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/paths.5815e531.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/index.f61edf3b.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/0.3ba41ccf.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/2.eb55a118.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/CodeBlock.38e566ae.js">
	<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/EditOnGithub.48fa589f.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"AutoTrain API","local":"autotrain-api","sections":[{"title":"Getting Started","local":"getting-started","sections":[],"depth":2},{"title":"Example Usage","local":"example-usage","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="autotrain-api" 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="#autotrain-api"><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>AutoTrain API</span></h1> <p data-svelte-h="svelte-uuaeev">With AutoTrain API, you can run your own instance of AutoTrain and use it to
	train models on Hugging Face Spaces infrastructure (local training coming soon).
	This API is designed to be used with autotrain compatible models and datasets, and it provides a simple interface to
	train models with minimal configuration.</p> <h2 class="relative group"><a id="getting-started" 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="#getting-started"><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>Getting Started</span></h2> <p data-svelte-h="svelte-1xw7p13">To get started with AutoTrain API, all you need to do is install <code>autotrain-advanced</code>
	as discussed in running locally section and run the autotrain app command:</p> <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 -->$ autotrain app --port 8000 --host 127.0.0.1<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-11fdiav">You can then access the API reference at <code>http://127.0.0.1:8000/docs</code>.</p> <h2 class="relative group"><a id="example-usage" 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="#example-usage"><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>Example Usage</span></h2> <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 -->curl -X POST <span class="hljs-string">"http://127.0.0.1:8000/api/create_project"</span> \
	-H <span class="hljs-string">"Content-Type: application/json"</span> \
	-H <span class="hljs-string">"Authorization: Bearer hf_XXXXX"</span> \
	-d <span class="hljs-string">'{
	"username": "abhishek",
	"project_name": "my-autotrain-api-model",
	"task": "llm:orpo",
	"base_model": "meta-llama/Meta-Llama-3-8B-Instruct",
	"hub_dataset": "argilla/distilabel-capybara-dpo-7k-binarized",
	"train_split": "train",
	"hardware": "spaces-a10g-large",
	"column_mapping": {
	"text_column": "chosen",
	"rejected_text_column": "rejected",
	"prompt_text_column": "prompt"
	},
	"params": {
	"block_size": 1024,
	"model_max_length": 4096,
	"max_prompt_length": 512,
	"epochs": 1,
	"batch_size": 2,
	"lr": 0.00003,
	"peft": true,
	"quantization": "int4",
	"target_modules": "all-linear",
	"padding": "right",
	"optimizer": "adamw_torch",
	"scheduler": "linear",
	"gradient_accumulation": 4,
	"mixed_precision": "fp16",
	"chat_template": "chatml"
	}
	}'</span><!-- HTML_TAG_END --></pre></div> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/autotrain-advanced/blob/main/docs/source/autotrain_api.mdx" 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_ewvlbq = {
	assets: "/docs/autotrain/pr_749/en",
	base: "/docs/autotrain/pr_749/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js"),
	import("/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 2],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 11.4 kB
Xet hash:: e925f44f76d86c37f33732867cdbc2de0e4c3eace04083546ff02ef1ebc0b36c

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