blob: 547efbffae0d0e010ea512152a7340b2ae4c4c71 [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Contributor Guide &mdash; tvm 0.17.dev0 documentation</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-rendered-html.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/tlcpack_theme.css" type="text/css" />
<link rel="shortcut icon" href="../_static/tvm-logo-square.png"/>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript" src="../_static/js/tlcpack_theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="TVM Community Guidelines" href="community.html" />
<link rel="prev" title="Docker Images" href="../install/docker.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<header class="header">
<div class="innercontainer">
<div class="headerInner d-flex justify-content-between align-items-center">
<div class="headerLogo">
<a href="https://tvm.apache.org/"><img src=https://tvm.apache.org/assets/images/logo.svg alt="logo"></a>
</div>
<div id="headMenu" class="headerNav">
<button type="button" id="closeHeadMenu" class="navCloseBtn"><img src="../_static/img/close-icon.svg" alt="Close"></button>
<ul class="nav">
<li class="nav-item">
<a class="nav-link" href=https://tvm.apache.org/community>Community</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://tvm.apache.org/download>Download</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://tvm.apache.org/vta>VTA</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://tvm.apache.org/blog>Blog</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://tvm.apache.org/docs>Docs</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://tvmconf.org>Conference</a>
</li>
<li class="nav-item">
<a class="nav-link" href=https://github.com/apache/tvm/>Github</a>
</li>
</ul>
<div class="responsivetlcdropdown">
<button type="button" class="btn-link">
ASF
</button>
<ul>
<li>
<a href=https://apache.org/>Apache Homepage</a>
</li>
<li>
<a href=https://www.apache.org/licenses/>License</a>
</li>
<li>
<a href=https://www.apache.org/foundation/sponsorship.html>Sponsorship</a>
</li>
<li>
<a href=https://www.apache.org/security/>Security</a>
</li>
<li>
<a href=https://www.apache.org/foundation/thanks.html>Thanks</a>
</li>
<li>
<a href=https://www.apache.org/events/current-event>Events</a>
</li>
</ul>
</div>
</div>
<div class="responsiveMenuIcon">
<button type="button" id="menuBtn" class="btn-menu"><img src="../_static/img/menu-icon.svg" alt="Menu Icon"></button>
</div>
<div class="tlcDropdown">
<div class="dropdown">
<button type="button" class="btn-link dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
ASF
</button>
<div class="dropdown-menu dropdown-menu-right">
<ul>
<li>
<a href=https://apache.org/>Apache Homepage</a>
</li>
<li>
<a href=https://www.apache.org/licenses/>License</a>
</li>
<li>
<a href=https://www.apache.org/foundation/sponsorship.html>Sponsorship</a>
</li>
<li>
<a href=https://www.apache.org/security/>Security</a>
</li>
<li>
<a href=https://www.apache.org/foundation/thanks.html>Thanks</a>
</li>
<li>
<a href=https://www.apache.org/events/current-event>Events</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</header>
<nav data-toggle="wy-nav-shift" class="wy-nav-side fixed">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/tvm-logo-small.png" class="logo" alt="Logo"/>
</a>
<input type="checkbox" class="version-toggle-box" hidden id="version-toggle">
<label for="version-toggle" class="version-toggle-label">
<div tabindex="0" class="version version-selector version-selector-show">
0.17.dev0 <span class="chevron versions-hidden"><svg fill="none" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="m8 4 8 8-8 8" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/></svg></span><span class="chevron versions-shown"><svg fill="none" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="m4 8 8 8 8-8" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/></svg></span>
</div>
</label>
<div class="version-details wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption" role="heading"><span class="caption-text">Versions</span></p>
<ol style="text-align: left">
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="/">0.17.dev0 (main)</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.8.0/">v0.8.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.9.0/">v0.9.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.10.0/">v0.10.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.11.0/">v0.11.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.12.0/">v0.12.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.13.0/">v0.13.0</a></div></li>
<li><div class="version"><a style="font-size: 0.8em; padding: 4px" href="v0.14.0/">v0.14.0</a></div></li>
</ol>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install/index.html">Installing TVM</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributor Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="community.html">TVM Community Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="pull_request.html">Submit a Pull Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Reviews</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html">Committer Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="document.html">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html">Code Guide and Tips</a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html">Git Usage Tips</a></li>
<li class="toctree-l2"><a class="reference internal" href="ci.html">Using TVM’s CI</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html">Release Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="error_handling.html">Error Handling Guide</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">User Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how_to/index.html">How To Guides</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../dev/tutorial/index.html">Developer Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/how_to/how_to.html">Developer How-To Guide</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Architecture Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../arch/index.html">Design and Architecture</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Topic Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../topic/microtvm/index.html">microTVM: TVM on bare-metal</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topic/vta/index.html">VTA: Versatile Tensor Accelerator</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/langref/index.html">Language Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/api/python/index.html">Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/api/links.html">Other APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation" data-toggle="wy-nav-top">
<div class="togglemenu">
</div>
<div class="nav-content">
<!-- tvm -->
Table of Contents
</div>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> <span class="br-arrow">></span></li>
<li>Contributor Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/tvm/edit/main/docs/contribute/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contributor-guide">
<h1>Contributor Guide<a class="headerlink" href="#contributor-guide" title="Permalink to this headline"></a></h1>
<p>TVM has been developed by community members.
Everyone is welcomed to contribute.
We value all forms of contributions, including, but not limited to:</p>
<ul class="simple">
<li><p>Code reviewing of the existing patches.</p></li>
<li><p>Documentation and usage examples</p></li>
<li><p>Community participation in forums and issues.</p></li>
<li><p>Code readability and developer guide</p>
<ul>
<li><p>We welcome contributions that add code comments
to improve readability</p></li>
<li><p>We also welcome contributions to docs to explain the
design choices of the internal.</p></li>
</ul>
</li>
<li><p>Test cases to make the codebase more robust</p></li>
<li><p>Tutorials, blog posts, talks that promote the project.</p></li>
</ul>
<p>Here are guidelines for contributing to various aspect of the project:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="community.html">TVM Community Guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="community.html#general-development-process">General Development Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="community.html#strategy-decision-process">Strategy Decision Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="community.html#committers">Committers</a></li>
<li class="toctree-l2"><a class="reference internal" href="community.html#reviewers">Reviewers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pull_request.html">Submit a Pull Request</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pull_request.html#guidelines">Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="pull_request.html#commit-message-guideline">Commit Message Guideline</a></li>
<li class="toctree-l2"><a class="reference internal" href="pull_request.html#ci-environment">CI Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="pull_request.html#testing">Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="code_review.html">Code Reviews</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#building-trust">Building Trust</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#community-participation">Community Participation</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#read-the-code-carefully">Read the code carefully</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#be-respectful">Be Respectful</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#factors-to-consider-about-code-quality">Factors to Consider about Code Quality</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#consensus-building">Consensus Building</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#consistency">Consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html#additional-recommendations">Additional Recommendations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="committer_guide.html">Committer Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#community-first">Community First</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#public-archive-principle">Public Archive Principle</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#independent-project-management">Independent Project Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#shepherd-a-pull-request">Shepherd a Pull Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#time-management">Time Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="committer_guide.html#broad-collaboration">Broad Collaboration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="document.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="document.html#the-four-document-types">The Four Document Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="document.html#technical-details">Technical Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="code_guide.html">Code Guide and Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html#c-code-styles">C++ Code Styles</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html#python-code-styles">Python Code Styles</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html#writing-python-tests">Writing Python Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html#network-resources">Network Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_guide.html#handle-integer-constant-expression">Handle Integer Constant Expression</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="git_howto.html">Git Usage Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#how-to-resolve-a-conflict-with-main">How to resolve a conflict with <code class="docutils literal notranslate"><span class="pre">main</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#how-to-combine-multiple-commits-into-one">How to combine multiple commits into one</a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#reset-to-the-most-recent-main-branch">Reset to the most recent main branch</a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#recover-a-previous-commit-after-reset">Recover a Previous Commit after Reset</a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#apply-only-k-latest-commits-on-to-the-main">Apply only k-Latest Commits on to the main</a></li>
<li class="toctree-l2"><a class="reference internal" href="git_howto.html#what-is-the-consequence-of-force-push">What is the consequence of force push</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ci.html">Using TVM’s CI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ci.html#for-contributors">For Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="ci.html#for-maintainers">For Maintainers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_process.html">Release Process</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#prepare-the-release-notes">Prepare the Release Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#prepare-the-release-candidate">Prepare the Release Candidate</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#prepare-the-gpg-key">Prepare the GPG Key</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#cut-a-release-candidate">Cut a Release Candidate</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#update-tvm-version-on-main">Update TVM Version on <code class="docutils literal notranslate"><span class="pre">main</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#upload-the-release-candidate">Upload the Release Candidate</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#cherry-picking">Cherry-Picking</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#call-a-vote-on-the-release-candidate">Call a Vote on the Release Candidate</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#post-the-release">Post the Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#update-the-tvm-website">Update the TVM Website</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#post-the-announcement">Post the Announcement</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_process.html#patch-releases">Patch Releases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="error_handling.html">Error Handling Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="error_handling.html#raise-a-specific-error-in-c">Raise a Specific Error in C++</a></li>
<li class="toctree-l2"><a class="reference internal" href="error_handling.html#how-to-choose-an-error-type">How to choose an Error Type</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="community.html" class="btn btn-neutral float-right" title="TVM Community Guidelines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../install/docker.html" class="btn btn-neutral float-left" title="Docker Images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div id="button" class="backtop"><img src="../_static/img/right.svg" alt="backtop"/> </div>
<section class="footerSec">
<div class="footerHeader">
<div class="d-flex align-md-items-center justify-content-between flex-column flex-md-row">
<div class="copywrite d-flex align-items-center">
<h5 id="copy-right-info">© 2023 Apache Software Foundation | All rights reserved</h5>
</div>
</div>
</div>
<div>
<div class="footernote">Copyright © 2023 The Apache Software Foundation. Apache TVM, Apache, the Apache feather, and the Apache TVM project logo are either trademarks or registered trademarks of the Apache Software Foundation.</div>
</div>
</section>
</footer>
</div>
</div>
</section>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
</body>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Theme Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75982049-2', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>