bitsandbytes/pr_1512/en/_app/immutable/nodes/2.e7901f57.js

import{s as nt,n as ot,o as lt}from"../chunks/scheduler.852ec091.js";import{S as at,i as st,g as s,s as o,r as x,A as mt,h as m,f as i,c as l,j as et,u as _,x as L,k as it,y as rt,a as n,v as C,d as T,t as k,w as P}from"../chunks/index.28275fd3.js";import{H as R,E as ut}from"../chunks/getInferenceSnippets.f859b5ca.js";function ct(K){let a,S,M,E,r,I,u,D,c,U,f,Q="<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>",G,d,V="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.",q,h,z,p,X="<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>",A,g,F,$,Y="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.",N,b,Z="Please see the existing documentation to see how to generate autodocs.",j,y,O,w,tt='<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>',W,v,B,H,J;return r=new R({props:{title:"Contribution Guide",local:"contribution-guide",headingTag:"h1"}}),u=new R({props:{title:"Setup",local:"setup",headingTag:"h2"}}),c=new R({props:{title:"Setup pre-commit hooks",local:"setup-pre-commit-hooks",headingTag:"h3"}}),h=new R({props:{title:"Ignore formatting revs",local:"ignore-formatting-revs",headingTag:"h3"}}),g=new R({props:{title:"Doc-string syntax",local:"doc-string-syntax",headingTag:"h2"}}),y=new R({props:{title:"Documentation",local:"documentation",headingTag:"h2"}}),v=new ut({props:{source:"https://github.com/bitsandbytes-foundation/bitsandbytes/blob/main/docs/source/contributing.mdx"}}),{c(){a=s("meta"),S=o(),M=s("p"),E=o(),x(r.$$.fragment),I=o(),x(u.$$.fragment),D=o(),x(c.$$.fragment),U=o(),f=s("ul"),f.innerHTML=Q,G=o(),d=s("p"),d.textContent=V,q=o(),x(h.$$.fragment),z=o(),p=s("ul"),p.innerHTML=X,A=o(),x(g.$$.fragment),F=o(),$=s("p"),$.textContent=Y,N=o(),b=s("p"),b.textContent=Z,j=o(),x(y.$$.fragment),O=o(),w=s("ul"),w.innerHTML=tt,W=o(),x(v.$$.fragment),B=o(),H=s("p"),this.h()},l(t){const e=mt("svelte-u9bgzb",document.head);a=m(e,"META",{name:!0,content:!0}),e.forEach(i),S=l(t),M=m(t,"P",{}),et(M).forEach(i),E=l(t),_(r.$$.fragment,t),I=l(t),_(u.$$.fragment,t),D=l(t),_(c.$$.fragment,t),U=l(t),f=m(t,"UL",{"data-svelte-h":!0}),L(f)!=="svelte-96yzim"&&(f.innerHTML=Q),G=l(t),d=m(t,"P",{"data-svelte-h":!0}),L(d)!=="svelte-1noivq4"&&(d.textContent=V),q=l(t),_(h.$$.fragment,t),z=l(t),p=m(t,"UL",{"data-svelte-h":!0}),L(p)!=="svelte-1ycf2ss"&&(p.innerHTML=X),A=l(t),_(g.$$.fragment,t),F=l(t),$=m(t,"P",{"data-svelte-h":!0}),L($)!=="svelte-pya2s1"&&($.textContent=Y),N=l(t),b=m(t,"P",{"data-svelte-h":!0}),L(b)!=="svelte-3sb6gr"&&(b.textContent=Z),j=l(t),_(y.$$.fragment,t),O=l(t),w=m(t,"UL",{"data-svelte-h":!0}),L(w)!=="svelte-970n75"&&(w.innerHTML=tt),W=l(t),_(v.$$.fragment,t),B=l(t),H=m(t,"P",{}),et(H).forEach(i),this.h()},h(){it(a,"name","hf:doc:metadata"),it(a,"content",ft)},m(t,e){rt(document.head,a),n(t,S,e),n(t,M,e),n(t,E,e),C(r,t,e),n(t,I,e),C(u,t,e),n(t,D,e),C(c,t,e),n(t,U,e),n(t,f,e),n(t,G,e),n(t,d,e),n(t,q,e),C(h,t,e),n(t,z,e),n(t,p,e),n(t,A,e),C(g,t,e),n(t,F,e),n(t,$,e),n(t,N,e),n(t,b,e),n(t,j,e),C(y,t,e),n(t,O,e),n(t,w,e),n(t,W,e),C(v,t,e),n(t,B,e),n(t,H,e),J=!0},p:ot,i(t){J||(T(r.$$.fragment,t),T(u.$$.fragment,t),T(c.$$.fragment,t),T(h.$$.fragment,t),T(g.$$.fragment,t),T(y.$$.fragment,t),T(v.$$.fragment,t),J=!0)},o(t){k(r.$$.fragment,t),k(u.$$.fragment,t),k(c.$$.fragment,t),k(h.$$.fragment,t),k(g.$$.fragment,t),k(y.$$.fragment,t),k(v.$$.fragment,t),J=!1},d(t){t&&(i(S),i(M),i(E),i(I),i(D),i(U),i(f),i(G),i(d),i(q),i(z),i(p),i(A),i(F),i($),i(N),i(b),i(j),i(O),i(w),i(W),i(B),i(H)),i(a),P(r,t),P(u,t),P(c,t),P(h,t),P(g,t),P(y,t),P(v,t)}}}const ft='{"title":"Contribution Guide","local":"contribution-guide","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}';function dt(K){return lt(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class $t extends at{constructor(a){super(),st(this,a,dt,ct,nt,{})}}export{$t as component};