Skip to content

Commit

Permalink
Pushing changes to GitHub Pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
docs-preview committed Aug 20, 2024
1 parent a1547a1 commit b0d1a78
Show file tree
Hide file tree
Showing 77 changed files with 29,493 additions and 0 deletions.
4 changes: 4 additions & 0 deletions review/pr-202/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0bc3eaaa85f3864066eeb413040cb61a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added review/pr-202/.nojekyll
View file
Empty file.
182 changes: 182 additions & 0 deletions review/pr-202/CONTRIBUTING.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<!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>Contributing &mdash; Merlin Key-Value Storage documentation</title><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/mystnb.css" type="text/css" />
<link rel="stylesheet" href="_static/togglebutton.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/css/banner.css" type="text/css" />
<link rel="canonical" href="https://nvidia-merlin.github.io/HierarchicalKV/master/CONTRIBUTING.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="./" 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 >let toggleHintShow = 'Click to show';</script>
<script >let toggleHintHide = 'Click to hide';</script>
<script >let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js"></script>
<script >var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Typedef nv::merlin::EraseIfPredict" href="api/typedef_merlin__hashtable_8cuh_1a5001706db6e977358e7f76ad6773703a.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home">
Merlin Key-Value Storage
</a>
<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="Navigation menu">
<p class="caption"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to HierarchicalKV</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#about-hierarchicalkv">About HierarchicalKV</a></li>
<li class="toctree-l2"><a class="reference internal" href="#maintainership">Maintainership</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#community">Community</a></li>
<li class="toctree-l2"><a class="reference internal" href="#licence">Licence</a></li>
</ul>
</li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Merlin Key-Value Storage</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Contributing</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="tex2jax_ignore mathjax_ignore section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h1>
<div class="section" id="about-hierarchicalkv">
<h2>About HierarchicalKV<a class="headerlink" href="#about-hierarchicalkv" title="Permalink to this headline"></a></h2>
<p>HierarchicalKV is a part of NVIDIA Merlin and provides hierarchical key-value storage to meet RecSys requirements.</p>
<p>The key capability of HierarchicalKV is to store key-value (feature-embedding) on high-bandwidth memory (HBM) of GPUs and in host memory.</p>
<p>You can also use the library for generic key-value storage.</p>
</div>
<div class="section" id="maintainership">
<h2>Maintainership<a class="headerlink" href="#maintainership" title="Permalink to this headline"></a></h2>
<p>HierarchicalKV is co-maintianed by <a class="reference external" href="https://github.com/NVIDIA-Merlin">NVIDIA Merlin Team</a> and NVIDIA product end-users,
and also open for public contributions, bug fixes, and documentation. This project adheres to NVIDIA’s Code of Conduct.</p>
</div>
<div class="section" id="id1">
<h2>Contributing<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<p>We’re grateful for your interest in HierarchicalKV and value your contributions.
We welcome contributions via pull requests(PR).</p>
<p>Before sending out a pull request for significant change on the end-user API, we recommend you open an issue and
discuss your proposed change. Some changes may require a design review.
All submissions require review by project reviewers.</p>
<div class="section" id="coding-style">
<h3>Coding Style<a class="headerlink" href="#coding-style" title="Permalink to this headline"></a></h3>
<p>Refer to the <a class="reference external" href="http://github.com/NVIDIA-Merlin/HierarchicalKV/STYLE_GUIDE.md">Style Guide</a></p>
</div>
<div class="section" id="additional-requirements">
<h3>Additional Requirements<a class="headerlink" href="#additional-requirements" title="Permalink to this headline"></a></h3>
<p>In addition to the above requirements, contribution also needs to meet the following criteria:</p>
<ul class="simple">
<li><p>The change needs to include unit tests and integration tests if any.</p></li>
<li><p>Each PR needs to provide necessary documentation for when and how to use it.</p></li>
</ul>
</div>
</div>
<div class="section" id="community">
<h2>Community<a class="headerlink" href="#community" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>HierarchicalKV code (<a class="reference external" href="https://github.com/NVIDIA-Merlin/HierarchicalKV">https://github.com/NVIDIA-Merlin/HierarchicalKV</a>)</p></li>
</ul>
</div>
<div class="section" id="licence">
<h2>Licence<a class="headerlink" href="#licence" title="Permalink to this headline"></a></h2>
<p>Apache License 2.0</p>
</div>
</div>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api/typedef_merlin__hashtable_8cuh_1a5001706db6e977358e7f76ad6773703a.html" class="btn btn-neutral float-left" title="Typedef nv::merlin::EraseIfPredict" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

<hr/>

<div role="contentinfo">

<p>&#169; Copyright 2022–2024, NVIDIA.</p>
<p>
<a href="https://www.nvidia.com/en-us/about-nvidia/privacy-policy/" target="_blank">Privacy Policy</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/privacy-center/" target="_blank">Manage My Privacy</a> |
<a href="https://www.nvidia.com/en-us/preferences/start/" target="_blank">Do Not Sell or Share My Data</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" target="_blank">Terms of Service</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/accessibility/" target="_blank">Accessibility</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/company-policies/" target="_blank">Corporate Policies</a> |
<a href="https://www.nvidia.com/en-us/product-security/" target="_blank">Product Security</a> |
<a href="https://www.nvidia.com/en-us/contact/" target="_blank">Contact</a>
</p>

</div>



</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Theme Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-NVJ1Y1YJHK"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'G-NVJ1Y1YJHK', {
'anonymize_ip': false,
});
</script>

</body>
</html>
Loading

0 comments on commit b0d1a78

Please sign in to comment.