Google Git
Sign in
apache / mxnet-site / b29f64d55499f1854ba5174ff443cf921bb86ea8 / . / versions / 1.4.1 / community / contribute.html
blob: 66ee6e6ecc33ae0bbaabc6fa04171be16be49bea [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta content="IE=edge" http-equiv="X-UA-Compatible"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<meta content="Contributing to MXNet" property="og:title">
<meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image">
<meta content="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/og-logo.png" property="og:image:secure_url">
<meta content="Contributing to MXNet" property="og:description"/>
<title>Contributing to MXNet — mxnet documentation</title>
<link crossorigin="anonymous" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" rel="stylesheet"/>
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet"/>
<link href="../_static/basic.css" rel="stylesheet" type="text/css">
<link href="../_static/pygments.css" rel="stylesheet" type="text/css">
<link href="../_static/mxnet.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="https://code.jquery.com/jquery-1.11.1.min.js" type="text/javascript"></script>
<script src="../_static/underscore.js" type="text/javascript"></script>
<script src="../_static/searchtools_custom.js" type="text/javascript"></script>
<script src="../_static/doctools.js" type="text/javascript"></script>
<script src="../_static/selectlang.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
<script type="text/javascript"> jQuery(function() { Search.loadIndex("/versions/1.4.1/searchindex.js"); Search.init();}); </script>
<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-96378503-1', 'auto');
ga('send', 'pageview');
</script>
<!-- -->
<!-- <script type="text/javascript" src="../_static/jquery.js"></script> -->
<!-- -->
<!-- <script type="text/javascript" src="../_static/underscore.js"></script> -->
<!-- -->
<!-- <script type="text/javascript" src="../_static/doctools.js"></script> -->
<!-- -->
<!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> -->
<!-- -->
<link href="../genindex.html" rel="index" title="Index">
<link href="../search.html" rel="search" title="Search"/>
<link href="index.html" rel="up" title="MXNet Community"/>
<link href="ecosystem.html" rel="next" title="MXNet’s Ecosystem"/>
<link href="index.html" rel="prev" title="MXNet Community"/>
<link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png"/>
</link></link></link></meta></meta></meta></head>
<body background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg" role="document">
<div class="content-block"><div class="navbar navbar-fixed-top">
<div class="container" id="navContainer">
<div class="innder" id="header-inner">
<h1 id="logo-wrap">
<a href="../" id="logo"><img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"/></a>
</h1>
<nav class="nav-bar" id="main-nav">
<a class="main-nav-link" href="/versions/1.4.1/install/index.html">Install</a>
<span id="dropdown-menu-position-anchor">
<a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Gluon <span class="caret"></span></a>
<ul class="dropdown-menu navbar-menu" id="package-dropdown-menu">
<li><a class="main-nav-link" href="/versions/1.4.1/tutorials/gluon/gluon.html">About</a></li>
<li><a class="main-nav-link" href="https://www.d2l.ai/">Dive into Deep Learning</a></li>
<li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li>
<li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li>
</ul>
</span>
<span id="dropdown-menu-position-anchor">
<a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">API <span class="caret"></span></a>
<ul class="dropdown-menu navbar-menu" id="package-dropdown-menu">
<li><a class="main-nav-link" href="/versions/1.4.1/api/python/index.html">Python</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/c++/index.html">C++</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/clojure/index.html">Clojure</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/java/index.html">Java</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/julia/index.html">Julia</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/perl/index.html">Perl</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/r/index.html">R</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/scala/index.html">Scala</a></li>
</ul>
</span>
<span id="dropdown-menu-position-anchor-docs">
<a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Docs <span class="caret"></span></a>
<ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-docs">
<li><a class="main-nav-link" href="/versions/1.4.1/faq/index.html">FAQ</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/tutorials/index.html">Tutorials</a>
<li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.4.1/example">Examples</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/architecture/index.html">Architecture</a></li>
<li><a class="main-nav-link" href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/model_zoo/index.html">Model Zoo</a></li>
<li><a class="main-nav-link" href="https://github.com/onnx/onnx-mxnet">ONNX</a></li>
</li></ul>
</span>
<span id="dropdown-menu-position-anchor-community">
<a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Community <span class="caret"></span></a>
<ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-community">
<li><a class="main-nav-link" href="http://discuss.mxnet.io">Forum</a></li>
<li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.4.1">Github</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/community/contribute.html">Contribute</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/community/ecosystem.html">Ecosystem</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/community/powered_by.html">Powered By</a></li>
</ul>
</span>
<span id="dropdown-menu-position-anchor-version" style="position: relative"><a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">1.4.1<span class="caret"></span></a><ul id="package-dropdown-menu" class="dropdown-menu"><li><a href="/">master</a></li><li><a href="/versions/1.7.0/">1.7.0</a></li><li><a href=/versions/1.6.0/>1.6.0</a></li><li><a href=/versions/1.5.0/>1.5.0</a></li><li><a href=/versions/1.4.1/>1.4.1</a></li><li><a href=/versions/1.3.1/>1.3.1</a></li><li><a href=/versions/1.2.1/>1.2.1</a></li><li><a href=/versions/1.1.0/>1.1.0</a></li><li><a href=/versions/1.0.0/>1.0.0</a></li><li><a href=/versions/0.12.1/>0.12.1</a></li><li><a href=/versions/0.11.0/>0.11.0</a></li></ul></span></nav>
<script> function getRootPath(){ return "../" } </script>
<div class="burgerIcon dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">☰</a>
<ul class="dropdown-menu" id="burgerMenu">
<li><a href="/versions/1.4.1/install/index.html">Install</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/tutorials/index.html">Tutorials</a></li>
<li class="dropdown-submenu dropdown">
<a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Gluon</a>
<ul class="dropdown-menu navbar-menu" id="package-dropdown-menu">
<li><a class="main-nav-link" href="/versions/1.4.1/tutorials/gluon/gluon.html">About</a></li>
<li><a class="main-nav-link" href="http://gluon.mxnet.io">The Straight Dope (Tutorials)</a></li>
<li><a class="main-nav-link" href="https://gluon-cv.mxnet.io">GluonCV Toolkit</a></li>
<li><a class="main-nav-link" href="https://gluon-nlp.mxnet.io/">GluonNLP Toolkit</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">API</a>
<ul class="dropdown-menu">
<li><a class="main-nav-link" href="/versions/1.4.1/api/python/index.html">Python</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/c++/index.html">C++</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/clojure/index.html">Clojure</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/java/index.html">Java</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/julia/index.html">Julia</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/perl/index.html">Perl</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/r/index.html">R</a></li>
<li><a class="main-nav-link" href="/versions/1.4.1/api/scala/index.html">Scala</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a aria-expanded="true" aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" tabindex="-1">Docs</a>
<ul class="dropdown-menu">
<li><a href="/versions/1.4.1/faq/index.html" tabindex="-1">FAQ</a></li>
<li><a href="/versions/1.4.1/tutorials/index.html" tabindex="-1">Tutorials</a></li>
<li><a href="https://github.com/apache/incubator-mxnet/tree/1.4.1/example" tabindex="-1">Examples</a></li>
<li><a href="/versions/1.4.1/architecture/index.html" tabindex="-1">Architecture</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home" tabindex="-1">Developer Wiki</a></li>
<li><a href="/versions/1.4.1/model_zoo/index.html" tabindex="-1">Gluon Model Zoo</a></li>
<li><a href="https://github.com/onnx/onnx-mxnet" tabindex="-1">ONNX</a></li>
</ul>
</li>
<li class="dropdown-submenu dropdown">
<a aria-haspopup="true" class="dropdown-toggle burger-link" data-toggle="dropdown" href="#" role="button" tabindex="-1">Community</a>
<ul class="dropdown-menu">
<li><a href="http://discuss.mxnet.io" tabindex="-1">Forum</a></li>
<li><a href="https://github.com/apache/incubator-mxnet/tree/1.4.1" tabindex="-1">Github</a></li>
<li><a href="/versions/1.4.1/community/contribute.html" tabindex="-1">Contribute</a></li>
<li><a href="/versions/1.4.1/community/ecosystem.html" tabindex="-1">Ecosystem</a></li>
<li><a href="/versions/1.4.1/community/powered_by.html" tabindex="-1">Powered By</a></li>
</ul>
</li>
<li id="dropdown-menu-position-anchor-version-mobile" class="dropdown-submenu" style="position: relative"><a href="#" tabindex="-1">1.4.1</a><ul class="dropdown-menu"><li><a tabindex="-1" href=/>master</a></li><li><a tabindex="-1" href=/versions/1.6.0/>1.6.0</a></li><li><a tabindex="-1" href=/versions/1.5.0/>1.5.0</a></li><li><a tabindex="-1" href=/versions/1.4.1/>1.4.1</a></li><li><a tabindex="-1" href=/versions/1.3.1/>1.3.1</a></li><li><a tabindex="-1" href=/versions/1.2.1/>1.2.1</a></li><li><a tabindex="-1" href=/versions/1.1.0/>1.1.0</a></li><li><a tabindex="-1" href=/versions/1.0.0/>1.0.0</a></li><li><a tabindex="-1" href=/versions/0.12.1/>0.12.1</a></li><li><a tabindex="-1" href=/versions/0.11.0/>0.11.0</a></li></ul></li></ul>
</div>
<div class="plusIcon dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button"><span aria-hidden="true" class="glyphicon glyphicon-plus"></span></a>
<ul class="dropdown-menu dropdown-menu-right" id="plusMenu"></ul>
</div>
<div id="search-input-wrap">
<form action="../search.html" autocomplete="off" class="" method="get" role="search">
<div class="form-group inner-addon left-addon">
<i class="glyphicon glyphicon-search"></i>
<input class="form-control" name="q" placeholder="Search" type="text"/>
</div>
<input name="check_keywords" type="hidden" value="yes">
<input name="area" type="hidden" value="default"/>
</input></form>
<div id="search-preview"></div>
</div>
<div id="searchIcon">
<span aria-hidden="true" class="glyphicon glyphicon-search"></span>
</div>
<!-- <div id="lang-select-wrap"> -->
<!-- <label id="lang-select-label"> -->
<!-- <\!-- <i class="fa fa-globe"></i> -\-> -->
<!-- <span></span> -->
<!-- </label> -->
<!-- <select id="lang-select"> -->
<!-- <option value="en">Eng</option> -->
<!-- <option value="zh">中文</option> -->
<!-- </select> -->
<!-- </div> -->
<!-- <a id="mobile-nav-toggle">
<span class="mobile-nav-toggle-bar"></span>
<span class="mobile-nav-toggle-bar"></span>
<span class="mobile-nav-toggle-bar"></span>
</a> -->
</div>
</div>
</div>
<script type="text/javascript">
$('body').css('background', 'white');
</script>
<div class="container">
<div class="row">
<div aria-label="main navigation" class="sphinxsidebar leftsidebar" role="navigation">
<div class="sphinxsidebarwrapper">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">MXNet APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">MXNet Architecture</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">MXNet Community</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Contributing to MXNet</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#getting-started">Getting Started</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mxnet-dev-communications">MXNet Dev Communications</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#forum">Forum</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mailing-lists">Mailing Lists</a></li>
<li class="toctree-l4"><a class="reference internal" href="#slack">Slack</a></li>
<li class="toctree-l4"><a class="reference internal" href="#social-media">Social Media</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#jira">JIRA</a></li>
<li class="toctree-l3"><a class="reference internal" href="#confluence-wiki">Confluence Wiki</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setup-mxnet-for-development">Setup MXNet for Development</a></li>
<li class="toctree-l3"><a class="reference internal" href="#your-first-contribution">Your First Contribution</a></li>
<li class="toctree-l3"><a class="reference internal" href="#file-a-bug-report">File a bug report</a></li>
<li class="toctree-l3"><a class="reference internal" href="#minor-fixes">Minor Fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#formal-pull-request-process">Formal Pull Request Process</a></li>
<li class="toctree-l3"><a class="reference internal" href="#new-feature-process">New Feature Process</a></li>
<li class="toctree-l3"><a class="reference internal" href="#roadmap">Roadmap</a></li>
<li class="toctree-l3"><a class="reference internal" href="#contributors">Contributors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="ecosystem.html">MXNet’s Ecosystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="powered_by.html">Powered By</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxnet_channels.html">Join MXNet Development Discussion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">MXNet FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gluon/index.html">About Gluon</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/index.html">Installing MXNet</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/index.html#nvidia-jetson-tx-family">Nvidia Jetson TX family</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/index.html#source-download">Source Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="../model_zoo/index.html">MXNet Model Zoo</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
</ul>
</div>
</div>
<div class="content">
<div class="page-tracker"></div>
<!--- Licensed to the Apache Software Foundation (ASF) under one -->
<!--- or more contributor license agreements. See the NOTICE file -->
<!--- distributed with this work for additional information -->
<!--- regarding copyright ownership. The ASF licenses this file -->
<!--- to you under the Apache License, Version 2.0 (the -->
<!--- "License"); you may not use this file except in compliance -->
<!--- with the License. You may obtain a copy of the License at --><!--- http://www.apache.org/licenses/LICENSE-2.0 --><!--- Unless required by applicable law or agreed to in writing, -->
<!--- software distributed under the License is distributed on an -->
<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
<!--- KIND, either express or implied. See the License for the -->
<!--- specific language governing permissions and limitations -->
<!--- under the License. --><div class="section" id="contributing-to-mxnet">
<span id="contributing-to-mxnet"></span><h1>Contributing to MXNet<a class="headerlink" href="#contributing-to-mxnet" title="Permalink to this headline"></a></h1>
<p>Apache MXNet (incubating) is a community led, open source deep learning project. We welcome new members and look forward to your contributions. Here you will find how to get started and links to detailed information on MXNet best practices and processes.</p>
<div class="section" id="getting-started">
<span id="getting-started"></span><h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<p>The following actions are recommended steps for you to get started with contributing to MXNet.</p>
<table border="1" class="docutils">
<colgroup>
<col width="50%"/>
<col width="50%"/>
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Action</th>
<th class="head">Purpose</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference external" href="#forum">Create a forum account</a></td>
<td>Asking &amp; answering MXNet usage questions</td>
</tr>
<tr class="row-odd"><td><a class="reference external" href="#mxnet-dev-communications">Join the dev comm channels</a></td>
<td>Discussions about the direction of MXNet</td>
</tr>
<tr class="row-even"><td><a class="reference external" href="#social-media">Follow MXNet on Social Media</a></td>
<td>Get updates about new features and events</td>
</tr>
<tr class="row-odd"><td><a class="reference external" href="#jira">Create a JIRA account</a></td>
<td>Tracking tasks &amp; prioritizing issues</td>
</tr>
<tr class="row-even"><td><a class="reference external" href="#confluence-wiki">Check out the MXNet wiki</a></td>
<td>The wiki has detailed contributor information</td>
</tr>
<tr class="row-odd"><td><a class="reference external" href="#setup-mxnet-for-development">Setup MXNet for development</a></td>
<td>Your very own fork for creating pull requests</td>
</tr>
<tr class="row-even"><td><a class="reference external" href="#your-first-contribution">Your first contribution</a></td>
<td>Complete a first contribution task</td>
</tr>
</tbody>
</table>
<div class="section" id="faq">
<span id="faq"></span><h3>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>I found a bug. How do I report it?<ul>
<li><a class="reference external" href="#file-a-bug-report">Bug submission info</a></li>
</ul>
</li>
<li>I have a minor bug fix or docs update I’d like to submit. What do I do?<ul>
<li><a class="reference external" href="#minor-fixes">Minor fixes process</a></li>
</ul>
</li>
<li>I would like to submit a pull request for a significant update. What is the process?<ul>
<li><a class="reference external" href="#formal-pull-request-process">Pull request process</a></li>
</ul>
</li>
<li>I want to propose a new feature. What is the process for this?<ul>
<li><a class="reference external" href="#new-feature-process">New feature process</a></li>
</ul>
</li>
<li>What’s coming next with MXNet, and how can I help?<ul>
<li><a class="reference external" href="#roadmap">Roadmap info</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="mxnet-dev-communications">
<span id="mxnet-dev-communications"></span><h2>MXNet Dev Communications<a class="headerlink" href="#mxnet-dev-communications" title="Permalink to this headline"></a></h2>
<div class="section" id="forum">
<span id="forum"></span><h3>Forum<a class="headerlink" href="#forum" title="Permalink to this headline"></a></h3>
<p>If you need help with using MXNet, have questions about applying it to a particular kind of problem, or have a discussion topic, please use the discussion forum:</p>
<ul class="simple">
<li><a class="reference external" href="https://discuss.mxnet.io">discuss.mxnet.io</a> <i class="fas fa-external-link-alt"></i></li>
</ul>
</div>
<div class="section" id="mailing-lists">
<span id="mailing-lists"></span><h3>Mailing Lists<a class="headerlink" href="#mailing-lists" title="Permalink to this headline"></a></h3>
<p>Please join either or both of the MXNet mailing lists:</p>
<p><strong>For MXNet Users, join the USER mailing list</strong>:</p>
<ul class="simple">
<li><a class="reference external" href="https://lists.apache.org/list.html?user@mxnet.apache.org">MXNet Apache USER mailing list</a> (user@mxnet.apache.org): To subscribe, send an email to <a href="mailto:user-subscribe@mxnet.apache.org">user-subscribe@mxnet.apache.org</a> <i class="far fa-envelope"></i></li>
</ul>
<p><strong>For Contributors to MXNet, join the DEV mailing list</strong>:</p>
<ul class="simple">
<li><a class="reference external" href="https://lists.apache.org/list.html?dev@mxnet.apache.org">MXNet Apache DEV mailing list</a> (dev@mxnet.apache.org): To subscribe, send an email to <a href="mailto:dev-subscribe@mxnet.apache.org">dev-subscribe@mxnet.apache.org</a> <i class="far fa-envelope"></i></li>
</ul>
<ul class="simple">
<li><a class="reference external" href="https://lists.apache.org/list.html?dev@mxnet.apache.org">archive</a> <i class="fas fa-external-link-alt"></i></li>
</ul>
</div>
<div class="section" id="slack">
<span id="slack"></span><h3>Slack<a class="headerlink" href="#slack" title="Permalink to this headline"></a></h3>
<p>To join the MXNet slack channel send request to the contributor mailing list.</p>
<ul class="simple">
<li><a href="mailto:dev@mxnet.apache.org?subject=Requesting%20slack%20access">email</a> <i class="far fa-envelope"></i></li>
<li><a class="reference external" href="https://the-asf.slackarchive.io/mxnet">archive</a> <i class="fas fa-external-link-alt"></i></li>
</ul>
</div>
<div class="section" id="social-media">
<span id="social-media"></span><h3>Social Media<a class="headerlink" href="#social-media" title="Permalink to this headline"></a></h3>
<p>Keep connected with the latest MXNet news and updates on <a class="reference external" href="https://twitter.com/apachemxnet">Twitter</a> and <a class="reference external" href="https://reddit.com/r/mxnet">Reddit</a>. Also, subscribe to the <a class="reference external" href="https://www.youtube.com/channel/UCQua2ZAkbr_Shsgfk1LCy6A">MXNet YouTube channel</a>.</p>
<div class="g-ytsubscribe" data-channelid="UCQua2ZAkbr_Shsgfk1LCy6A" data-count="hidden" data-layout="full"></div>
<br/><br/>
<a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/apachemxnet?ref_src=twsrc%5Etfw">Follow @apachemxnet</a><script async="" charset="utf-8" src="https://platform.twitter.com/widgets.js"></script>
<br/><br/>
<a href="https://reddit.com/r/mxnet"><img alt="reddit" border="0" src="https://www.redditstatic.com/spreddit5.gif"> r/mxnet</img></a></div>
</div>
<div class="section" id="jira">
<span id="jira"></span><h2>JIRA<a class="headerlink" href="#jira" title="Permalink to this headline"></a></h2>
<p>MXNet uses Apache’s JIRA to track issues and larger projects. Anyone can review open issues, but in order create issues or view JIRA boards, you must create an account.</p>
<ul class="simple">
<li><a class="reference external" href="https://issues.apache.org/jira/projects/MXNET/issues">Open JIRA Issues</a></li>
<li><a class="reference external" href="https://issues.apache.org/jira/secure/RapidBoard.jspa">JIRA boards</a> <i class="fas fa-lock"></i></li>
</ul>
</div>
<div class="section" id="confluence-wiki">
<span id="confluence-wiki"></span><h2>Confluence Wiki<a class="headerlink" href="#confluence-wiki" title="Permalink to this headline"></a></h2>
<p>The <a class="reference external" href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">MXNet Confluence Wiki</a> has detailed development environment setup info, design proposals, release process info, and more. This is generally where contributor information is maintained.</p>
<ul class="simple">
<li><a class="reference external" href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">MXNet Confluence Wiki</a> <i class="fas fa-external-link-alt"></i></li>
</ul>
</div>
<div class="section" id="setup-mxnet-for-development">
<span id="setup-mxnet-for-development"></span><h2>Setup MXNet for Development<a class="headerlink" href="#setup-mxnet-for-development" title="Permalink to this headline"></a></h2>
<p>The process for setting up MXNet for development depends on several factors, and is constantly being improved and expanded for more development languages. Setup information is on the MXNet Confluence Wiki.</p>
<ul class="simple">
<li><a class="reference external" href="https://cwiki.apache.org/confluence/display/MXNET/Development">MXNet Confluence Wiki: Development</a> <i class="fas fa-external-link-alt"></i></li>
</ul>
</div>
<div class="section" id="your-first-contribution">
<span id="your-first-contribution"></span><h2>Your First Contribution<a class="headerlink" href="#your-first-contribution" title="Permalink to this headline"></a></h2>
<p><strong>Step 1</strong>: Visit the project on GitHub and review the <a class="reference external" href="https://github.com/apache/incubator-mxnet/labels/Call%20for%20Contribution">calls for contribution</a>. Click the GitHub button:
<a aria-label="Issue apache/incubator-mxnet on GitHub" class="github-button" data-show-count="true" data-size="large" href="https://github.com/apache/incubator-mxnet/labels/Call%20for%20Contribution">Call for Contribution</a></p>
<p><strong>Step 2</strong>: Tackle a smaller issue or improve documentation to get familiar with the process. As part of your pull request, add your name to <a class="reference external" href="https://github.com/apache/incubator-mxnet/blob/master/CONTRIBUTORS.md">CONTRIBUTORS.md</a>.</p>
<p><strong>Step 3</strong>: Follow the <a class="reference external" href="#formal-pull-request-process">formal pull request (PR) process</a> to submit your PR for review.</p>
<p><strong>Important</strong>: keep an eye on your pull request, respond to comments and change requests, and rebase or resubmit your PR if fails the Jenkins continuous integration tests. Ask for help in the <a class="reference external" href="#mxnet-dev-communications">forum or slack channel</a> if you get stuck.</p>
</div>
<div class="section" id="file-a-bug-report">
<span id="file-a-bug-report"></span><h2>File a bug report<a class="headerlink" href="#file-a-bug-report" title="Permalink to this headline"></a></h2>
<p>Please let us know if you experienced a problem with MXNet. Please provide detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem. You have two alternatives for filing a bug report:</p>
<p><a href="http://issues.apache.org/jira/browse/MXNet"><i class="fas fa-bug"></i> JIRA</a></p>
<p><a href="https://github.com/apache/incubator-mxnet/issues"><i class="fab fa-github"></i> GitHub</a></p></div>
<div class="section" id="minor-fixes">
<span id="minor-fixes"></span><h2>Minor Fixes<a class="headerlink" href="#minor-fixes" title="Permalink to this headline"></a></h2>
<p>If you have found an issue and would like to contribute a bug fix or documentation update, follow these guidelines:</p>
<ul class="simple">
<li>If it is trivial, just create a <a class="reference external" href="https://github.com/apache/incubator-mxnet/pulls">pull request</a>.</li>
<li>If it is non-trivial, you should follow the <a class="reference external" href="#formal-pull-request-process">formal pull request process</a> described in the next section.</li>
</ul>
</div>
<div class="section" id="formal-pull-request-process">
<span id="formal-pull-request-process"></span><h2>Formal Pull Request Process<a class="headerlink" href="#formal-pull-request-process" title="Permalink to this headline"></a></h2>
<p>Any new features of improvements that are non-trivial should follow the complete flow of:</p>
<ol class="simple">
<li><a class="reference external" href="https://cwiki.apache.org/confluence/display/MXNET/Development+Process">Review the contribution standards</a> for your type of submission.</li>
<li><a class="reference external" href="https://issues.apache.org/jira/secure/CreateIssue!default.jspa">Create a JIRA issue</a>.</li>
<li><a class="reference external" href="https://github.com/apache/incubator-mxnet/pulls">Create the PR on GitHub</a> and add the JIRA issue ID to the PR’s title.</li>
</ol>
<p>Further details on this process can be found on the <a class="reference external" href="https://cwiki.apache.org/confluence/display/MXNET/Development">Wiki</a>.</p>
</div>
<div class="section" id="new-feature-process">
<span id="new-feature-process"></span><h2>New Feature Process<a class="headerlink" href="#new-feature-process" title="Permalink to this headline"></a></h2>
<p>Our community is constantly looking for feedback to improve Apache MXNet. If you have an idea how to improve MXNet or have a new feature in mind that would be beneficial for MXNet users, please open an issue in <a class="reference external" href="http://issues.apache.org/jira/browse/MXNet">MXNet’s JIRA</a>. The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:<br/></p>
<ul class="simple">
<li>It ensures your requirements are met when the improvement or feature is implemented.<br/></li>
<li>It helps to estimate the effort and to design a solution that addresses your needs. <br/></li>
<li>It allows for constructive discussions that might arise around this issue.</li>
</ul>
<p>Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the <a class="reference external" href="/versions/1.4.1/community/contribute.html">contributions</a> guide in this case as well.</p>
</div>
<div class="section" id="roadmap">
<span id="roadmap"></span><h2>Roadmap<a class="headerlink" href="#roadmap" title="Permalink to this headline"></a></h2>
<p>MXNet is evolving fast. To see what’s next and what the community is currently working on, check out the Roadmap issues on GitHub and the JIRA Boards:</p>
<p><a aria-label="Issue apache/incubator-mxnet on GitHub" class="github-button" data-show-count="true" data-size="large" href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Roadmap</a>
<br/>
<a class="reference external" href="https://issues.apache.org/jira/secure/RapidBoard.jspa">JIRA boards</a> <i class="fas fa-lock"></i></p>
<script crossorigin="anonymous" defer="" integrity="sha384-Voup2lBiiyZYkRto2XWqbzxHXwzcm4A5RfdfG6466bu5LqjwwrjXCMBQBLMWh7qR" src="https://use.fontawesome.com/releases/v5.0.12/js/all.js"></script>
<script async="" defer="" src="https://buttons.github.io/buttons.js"></script>
<script src="https://apis.google.com/js/platform.js"></script></div>
<div class="section" id="contributors">
<span id="contributors"></span><h2>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline"></a></h2>
<p>MXNet has been developed by and is used by a group of active community members. Contribute to improving it!</p>
<p><i class="fab fa-github"></i> <a class="reference external" href="https://github.com/apache/incubator-mxnet/blob/master/CONTRIBUTORS.md">Contributors and Committers</a></p>
</div>
</div>
</div>
</div>
<div aria-label="main navigation" class="sphinxsidebar rightsidebar" role="navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contributing to MXNet</a><ul>
<li><a class="reference internal" href="#getting-started">Getting Started</a><ul>
<li><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mxnet-dev-communications">MXNet Dev Communications</a><ul>
<li><a class="reference internal" href="#forum">Forum</a></li>
<li><a class="reference internal" href="#mailing-lists">Mailing Lists</a></li>
<li><a class="reference internal" href="#slack">Slack</a></li>
<li><a class="reference internal" href="#social-media">Social Media</a></li>
</ul>
</li>
<li><a class="reference internal" href="#jira">JIRA</a></li>
<li><a class="reference internal" href="#confluence-wiki">Confluence Wiki</a></li>
<li><a class="reference internal" href="#setup-mxnet-for-development">Setup MXNet for Development</a></li>
<li><a class="reference internal" href="#your-first-contribution">Your First Contribution</a></li>
<li><a class="reference internal" href="#file-a-bug-report">File a bug report</a></li>
<li><a class="reference internal" href="#minor-fixes">Minor Fixes</a></li>
<li><a class="reference internal" href="#formal-pull-request-process">Formal Pull Request Process</a></li>
<li><a class="reference internal" href="#new-feature-process">New Feature Process</a></li>
<li><a class="reference internal" href="#roadmap">Roadmap</a></li>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div><div class="footer">
<div class="section-disclaimer">
<div class="container">
<div>
<img height="60" src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/apache_incubator_logo.png"/>
<p>
Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <strong>sponsored by the <i>Apache Incubator</i></strong>. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</p>
<p>
"Copyright © 2017-2018, The Apache Software Foundation
Apache MXNet, MXNet, Apache, the Apache feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the Apache Software Foundation."
</p>
</div>
</div>
</div>
</div> <!-- pagename != index -->
</div>
<script crossorigin="anonymous" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
<script src="../_static/js/sidebar.js" type="text/javascript"></script>
<script src="../_static/js/search.js" type="text/javascript"></script>
<script src="../_static/js/navbar.js" type="text/javascript"></script>
<script src="../_static/js/clipboard.min.js" type="text/javascript"></script>
<script src="../_static/js/copycode.js" type="text/javascript"></script>
<script src="../_static/js/page.js" type="text/javascript"></script>
<script src="../_static/js/docversion.js" type="text/javascript"></script>
<script type="text/javascript">
$('body').ready(function () {
$('body').css('visibility', 'visible');
});
</script>
</body>
</html>