Adding better doc-strings for retrieval & ranking models#297
Adding better doc-strings for retrieval & ranking models#297marcromeyn wants to merge 6 commits intomainfrom
Conversation
|
@marcromeyn can we get this updated for the release on tuesday? |
Click to view CI ResultsGitHub pull request #297 of commit de75b4887ffd302256b7e08272a7a4f8e9dcf386, no merge conflicts.
Running as SYSTEM
Setting status of de75b4887ffd302256b7e08272a7a4f8e9dcf386 to PENDING with url https://10.20.13.93:8080/job/merlin_models/23/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse de75b4887ffd302256b7e08272a7a4f8e9dcf386^{commit} # timeout=10
Checking out Revision de75b4887ffd302256b7e08272a7a4f8e9dcf386 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f de75b4887ffd302256b7e08272a7a4f8e9dcf386 # timeout=10
Commit message: "Adding some TODOs in doc-strings for the different models"
> git rev-list --no-walk 059143e1436ed85cd7079bd5c2df46d5854bb256 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins453863342514889078.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 356 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit b81dc4f60caa2abf34499a46e2a66b4befaec0b1, no merge conflicts.
Running as SYSTEM
Setting status of b81dc4f60caa2abf34499a46e2a66b4befaec0b1 to PENDING with url https://10.20.13.93:8080/job/merlin_models/26/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse b81dc4f60caa2abf34499a46e2a66b4befaec0b1^{commit} # timeout=10
Checking out Revision b81dc4f60caa2abf34499a46e2a66b4befaec0b1 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f b81dc4f60caa2abf34499a46e2a66b4befaec0b1 # timeout=10
Commit message: "Merge branch 'main' into docs-strings"
> git rev-list --no-walk 61eb2d16c42e7e8329b34c98a610648a277fa999 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins4791854731430907704.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 372 items / 2 skipped
|
Documentation preview |
Click to view CI ResultsGitHub pull request #297 of commit f343a2a3d1ec4300ef4026e8e9baa5ee377252de, no merge conflicts.
Running as SYSTEM
Setting status of f343a2a3d1ec4300ef4026e8e9baa5ee377252de to PENDING with url https://10.20.13.93:8080/job/merlin_models/27/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse f343a2a3d1ec4300ef4026e8e9baa5ee377252de^{commit} # timeout=10
Checking out Revision f343a2a3d1ec4300ef4026e8e9baa5ee377252de (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f f343a2a3d1ec4300ef4026e8e9baa5ee377252de # timeout=10
Commit message: "Some fixes"
> git rev-list --no-walk b81dc4f60caa2abf34499a46e2a66b4befaec0b1 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins8077946896278843898.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 103 items / 27 errors / 3 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 8cac015ca0326bb41dceeef66913cfa07d83375b, no merge conflicts.
Running as SYSTEM
Setting status of 8cac015ca0326bb41dceeef66913cfa07d83375b to PENDING with url https://10.20.13.93:8080/job/merlin_models/28/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 8cac015ca0326bb41dceeef66913cfa07d83375b^{commit} # timeout=10
Checking out Revision 8cac015ca0326bb41dceeef66913cfa07d83375b (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 8cac015ca0326bb41dceeef66913cfa07d83375b # timeout=10
Commit message: "Fix NCFModel"
> git rev-list --no-walk f343a2a3d1ec4300ef4026e8e9baa5ee377252de # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins8714959019930468576.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 372 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266, no merge conflicts.
Running as SYSTEM
Setting status of 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266 to PENDING with url https://10.20.13.93:8080/job/merlin_models/29/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266^{commit} # timeout=10
Checking out Revision 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266 # timeout=10
Commit message: "Trying to fix prettier in pre-commit"
> git rev-list --no-walk 8cac015ca0326bb41dceeef66913cfa07d83375b # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins5117959117349032417.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 372 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 90af15bd6097bf4447c7e42daff01b177b684478, no merge conflicts.
Running as SYSTEM
Setting status of 90af15bd6097bf4447c7e42daff01b177b684478 to PENDING with url https://10.20.13.93:8080/job/merlin_models/30/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 90af15bd6097bf4447c7e42daff01b177b684478^{commit} # timeout=10
Checking out Revision 90af15bd6097bf4447c7e42daff01b177b684478 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 90af15bd6097bf4447c7e42daff01b177b684478 # timeout=10
Commit message: "Trying to fix prettier in pre-commit"
> git rev-list --no-walk 0ad9146f031b5aa43fa2a0b0ab64b1baeecaa266 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins589259074747473988.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 372 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 7482700e50e71b3165936cccf464e430c502f947, no merge conflicts.
Running as SYSTEM
Setting status of 7482700e50e71b3165936cccf464e430c502f947 to PENDING with url https://10.20.13.93:8080/job/merlin_models/70/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 7482700e50e71b3165936cccf464e430c502f947^{commit} # timeout=10
Checking out Revision 7482700e50e71b3165936cccf464e430c502f947 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 7482700e50e71b3165936cccf464e430c502f947 # timeout=10
Commit message: "Trying to fix prettier in pre-commit"
> git rev-list --no-walk 9d4e89e69e3bd7a7aee6982295552c340001b173 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins8039959751512138505.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 373 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 5b135ebd5bbd2340185b5c3f11074b35b84cbfc2, no merge conflicts.
Running as SYSTEM
Setting status of 5b135ebd5bbd2340185b5c3f11074b35b84cbfc2 to PENDING with url https://10.20.13.93:8080/job/merlin_models/71/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 5b135ebd5bbd2340185b5c3f11074b35b84cbfc2^{commit} # timeout=10
Checking out Revision 5b135ebd5bbd2340185b5c3f11074b35b84cbfc2 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 5b135ebd5bbd2340185b5c3f11074b35b84cbfc2 # timeout=10
Commit message: "fix youtube-dnn docstrings"
> git rev-list --no-walk 7482700e50e71b3165936cccf464e430c502f947 # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins6900943387910905316.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 373 items / 2 skipped
|
Click to view CI ResultsGitHub pull request #297 of commit 0895d0a7124548b3eb09ae363e78a50aa30a9292, no merge conflicts.
Running as SYSTEM
Setting status of 0895d0a7124548b3eb09ae363e78a50aa30a9292 to PENDING with url https://10.20.13.93:8080/job/merlin_models/80/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_models
using credential nvidia-merlin-bot
> git rev-parse --is-inside-work-tree # timeout=10
Fetching changes from the remote Git repository
> git config remote.origin.url https://github.com/NVIDIA-Merlin/models/ # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/models/
> git --version # timeout=10
using GIT_ASKPASS to set credentials This is the bot credentials for our CI/CD
> git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/models/ +refs/pull/297/*:refs/remotes/origin/pr/297/* # timeout=10
> git rev-parse 0895d0a7124548b3eb09ae363e78a50aa30a9292^{commit} # timeout=10
Checking out Revision 0895d0a7124548b3eb09ae363e78a50aa30a9292 (detached)
> git config core.sparsecheckout # timeout=10
> git checkout -f 0895d0a7124548b3eb09ae363e78a50aa30a9292 # timeout=10
Commit message: "Merge branch 'main' into docs-strings"
> git rev-list --no-walk 8f0adfe447c529fba71e5d7d5e839d4f0fc8022b # timeout=10
[merlin_models] $ /bin/bash /tmp/jenkins6986482734783243032.sh
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_models/models, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 373 items / 2 skipped
|
| TODO: Make sure it can link to the Schema & Tags | ||
| TODO: Link to tutorial |
There was a problem hiding this comment.
Can we just remove this for now (or make a comment instead of a TODO in the docstring?)
| TODO: Make sure it can link to the Schema & Tags | |
| TODO: Link to tutorial |
| The tag to select item features, by default `Tags.ITEM` | ||
| The tag to select the item feature, by default `Tags.ITEM` | ||
| embeddings_initializers: Dict[str, Callable[[Any], None]] | ||
| TODO: List different popular initializers, and how to provide them. Type-hint is wrong now. |
There was a problem hiding this comment.
| TODO: List different popular initializers, and how to provide them. Type-hint is wrong now. |
| @@ -1,19 +0,0 @@ | |||
| from typing import List, Optional, Union | |||
There was a problem hiding this comment.
I think this file is still relied on in places like
models/merlin/models/tf/blocks/core/base.py
Line 589 in 6ad79d3
viswa-nvidia
added
epic?
|
Moved to arbitration. Not clear how this maps to the roadmap . @marcromeyn , please clarify. |
1 similar comment
|
Moved to arbitration. Not clear how this maps to the roadmap . @marcromeyn , please clarify. |
|
@marcromeyn is this PR still relevant? Are you active working on it? Can we close it OR move it to need prioritization/clarification? |
|
We have a new API so this one can be closed |
6 participants
Fixes # (issue)
Goals ⚽
Implementation Details 🚧
Testing Details 🔍