Buckets:

hf-doc-build
/

doc-dev

hf-doc-build/doc-dev / bitsandbytes /pr_1137 /en /contributing.html

12.6 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Contributors guidelines","local":"contributors-guidelines","sections":[{"title":"Setup","local":"setup","sections":[{"title":"Setup pre-commit hooks","local":"setup-pre-commit-hooks","sections":[],"depth":3},{"title":"Ignore formatting revs","local":"ignore-formatting-revs","sections":[],"depth":3}],"depth":2},{"title":"Doc-string syntax","local":"doc-string-syntax","sections":[],"depth":2},{"title":"Documentation","local":"documentation","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/bitsandbytes/pr_1137/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/entry/start.435ebb3a.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/scheduler.852ec091.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/singletons.c3371655.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/index.268e315a.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/paths.5769d97d.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/entry/app.6b2aadb8.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/index.28275fd3.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/nodes/0.fece9a53.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/nodes/3.243404bd.js">
	<link rel="modulepreload" href="/docs/bitsandbytes/pr_1137/en/_app/immutable/chunks/EditOnGithub.582011f0.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Contributors guidelines","local":"contributors-guidelines","sections":[{"title":"Setup","local":"setup","sections":[{"title":"Setup pre-commit hooks","local":"setup-pre-commit-hooks","sections":[],"depth":3},{"title":"Ignore formatting revs","local":"ignore-formatting-revs","sections":[],"depth":3}],"depth":2},{"title":"Doc-string syntax","local":"doc-string-syntax","sections":[],"depth":2},{"title":"Documentation","local":"documentation","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="contributors-guidelines" 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="#contributors-guidelines"><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>Contributors guidelines</span></h1> <p data-svelte-h="svelte-1mlh5eh">… still under construction … (feel free to propose materials, <code>bitsandbytes</code> is a community project)</p> <h2 class="relative group"><a id="setup" 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="#setup"><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>Setup</span></h2> <h3 class="relative group"><a id="setup-pre-commit-hooks" 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="#setup-pre-commit-hooks"><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>Setup pre-commit hooks</span></h3> <ul data-svelte-h="svelte-96yzim"><li>Install pre-commit hooks with <code>pip install pre-commit</code>.</li> <li>Run <code>pre-commit install</code> once to install the hooks, so they will be run on every commit.</li> <li>If the hooks introduce changes, they’ll be visible with <code>git diff</code>. Review them and <code>git add</code> them if everything is fine, then re-execute the before commit, it should pass now.</li> <li>If you want to manually trigger the hooks, you may do <code>pre-commit run --all-files</code></li></ul> <p data-svelte-h="svelte-1noivq4">Now all the pre-commit hooks will be automatically run when you try to commit and if they introduce some changes, you need to re-add the changed files before being able to commit and push.</p> <h3 class="relative group"><a id="ignore-formatting-revs" 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="#ignore-formatting-revs"><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>Ignore formatting revs</span></h3> <ul data-svelte-h="svelte-1ycf2ss"><li>Run <code>git config blame.ignoreRevsFile .git-blame-ignore-revs</code>. This will make it so that <code>git blame</code> is aware of commits that were logged to be solely formatting-related.</li></ul> <h2 class="relative group"><a id="doc-string-syntax" 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="#doc-string-syntax"><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>Doc-string syntax</span></h2> <p data-svelte-h="svelte-pya2s1">We’re following NumPy doc-string conventions with the only notable difference being that we use Markdown instead of Rich text format (RTF) for markup within the doc-strings.</p> <p data-svelte-h="svelte-3sb6gr">Please see the existing documentation to see how to generate autodocs.</p> <h2 class="relative group"><a id="documentation" 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="#documentation"><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>Documentation</span></h2> <ul data-svelte-h="svelte-970n75"><li><a href="https://github.com/huggingface/doc-builder#readme" rel="nofollow">guideline for documentation syntax</a></li> <li>images shall be uploaded via PR in the <code>bitsandbytes/</code> directory <a href="https://huggingface.co/datasets/huggingface/documentation-images" rel="nofollow">here</a></li> <li>find the documentation builds for each PR in a link posted to the PR, such as <a href="https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction" rel="nofollow">https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction</a></li></ul> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/bitsandbytes-foundation/bitsandbytes/blob/main/docs/source/contributing.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_1amjjgw = {
	assets: "/docs/bitsandbytes/pr_1137/en",
	base: "/docs/bitsandbytes/pr_1137/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/bitsandbytes/pr_1137/en/_app/immutable/entry/start.435ebb3a.js"),
	import("/docs/bitsandbytes/pr_1137/en/_app/immutable/entry/app.6b2aadb8.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 3],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 12.6 kB
Xet hash:: d9dce008da5358a9ab9d054ed5b83296bfa13a1cd24bbd069231f426c8d81c80

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