-
- Beginning in January 2023, versions for all NVIDIA Merlin projects
- will change from semantic versioning like 4.0
- to calendar versioning like 23.01
.
-
-{% endblock %}
+{%- extends "!layout.html" %}
+
+{%- block extrahead %}
+ {%- if analytics_id %}
+
+
+
+ {% endif %}
+
+
+
+
+{%- endblock %}
diff --git a/docs/source/_templates/merlin-ecosystem.html b/docs/source/_templates/merlin-ecosystem.html
new file mode 100644
index 0000000000..c925bb1442
--- /dev/null
+++ b/docs/source/_templates/merlin-ecosystem.html
@@ -0,0 +1,14 @@
+
+
+
diff --git a/docs/source/_templates/versions.html b/docs/source/_templates/versions.html
index 31a1257898..26e2a32fcd 100644
--- a/docs/source/_templates/versions.html
+++ b/docs/source/_templates/versions.html
@@ -1,7 +1,7 @@
{%- if current_version %}
- Other Versions
+
v: {{ current_version.name }}
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a062665709..e110990e32 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -42,7 +42,7 @@
# -- Project information -----------------------------------------------------
project = "Merlin Models"
-copyright = "2022, NVIDIA"
+copyright = "2023, NVIDIA"
author = "NVIDIA"
@@ -54,7 +54,6 @@
extensions = [
"myst_nb",
"sphinx_multiversion",
- "sphinx_rtd_theme",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.coverage",
@@ -96,17 +95,34 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+html_title = "NVIDIA Merlin Models"
+html_favicon = "_static/favicon.png"
html_theme_options = {
- "navigation_depth": 2,
- "analytics_id": "G-NVJ1Y1YJHK",
+ "repository_url": "https://github.com/NVIDIA-Merlin/models",
+ "use_repository_button": True,
+ "footer_content_items": ["copyright.html", "last-updated.html"],
+ "extra_footer": "",
+ "logo": {"text": "NVIDIA Merlin Models", "alt_text": "NVIDIA Merlin Models"},
}
+html_sidebars = {
+ "**": [
+ "navbar-logo.html",
+ "search-field.html",
+ "icon-links.html",
+ "sbt-sidebar-nav.html",
+ "merlin-ecosystem.html",
+ "versions.html",
+ ]
+}
+html_context = {"analytics_id": "G-NVJ1Y1YJHK"}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
-html_css_files = ["css/custom.css"]
+html_css_files = ["css/custom.css", "css/versions.css"]
+html_js_files = ["js/rtd-version-switcher.js"]
source_suffix = [".rst", ".md"]
@@ -126,7 +142,6 @@
smv_refs_override_suffix = r"-docs"
-html_sidebars = {"**": ["versions.html"]}
html_baseurl = "https://nvidia-merlin.github.io/models/stable/"
intersphinx_mapping = {
diff --git a/requirements/docs.txt b/requirements/docs.txt
index 2e72b146ad..6f335f911f 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -1,12 +1,11 @@
attrs==21.4.0
Jinja2<3.1
linkify-it-py==1.0.3
-myst-nb==0.13.2
+myst-nb
natsort==8.1.0
recommonmark==0.7.1
-sphinx_rtd_theme==1.0.0
+sphinx_book_theme~=1.0.1
sphinx-external-toc==0.2.4
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
-Sphinx==3.5.4
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
ipython==8.2.0
From cd4f114bd0300c2ec81e1d8efa261bdf3ebd4e83 Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Thu, 6 Jul 2023 14:02:44 +0100
Subject: [PATCH 2/3] Add missing `PrepareListFeatures` to merlin.models.tf
module
---
merlin/models/tf/__init__.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/merlin/models/tf/__init__.py b/merlin/models/tf/__init__.py
index 85708e2a4c..da62ef0a7e 100644
--- a/merlin/models/tf/__init__.py
+++ b/merlin/models/tf/__init__.py
@@ -155,6 +155,7 @@
HashedCross,
HashedCrossAll,
PrepareFeatures,
+ PrepareListFeatures,
ToDense,
ToOneHot,
ToSparse,
@@ -226,6 +227,7 @@
"MatrixFactorizationBlock",
"QueryItemIdsEmbeddingsBlock",
"PrepareFeatures",
+ "PrepareListFeatures",
"ToSparse",
"ToDense",
"ToTarget",
From 7d4e2faa1f11df564049aaa65307b186fe3ee3b3 Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Thu, 6 Jul 2023 14:03:46 +0100
Subject: [PATCH 3/3] Add upper bound on tensorflow version
---
requirements/tensorflow.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements/tensorflow.txt b/requirements/tensorflow.txt
index 95fa5dd10e..203cf5888c 100644
--- a/requirements/tensorflow.txt
+++ b/requirements/tensorflow.txt
@@ -1 +1 @@
-tensorflow>=2.9
+tensorflow>=2.9,<2.13