README updates by benfred · Pull Request #53 · NVIDIA-Merlin/core

benfred · 2022-03-31T16:55:49Z

Add badges
Add Feedback/support section
Add docker install instructions

* Add badges * Add Feedback/support section * Add docker install instructions

github-actions · 2022-03-31T16:58:25Z

Documentation preview

https://nvidia-merlin.github.io/core/review/pr-53

mikemckiernan · 2022-03-31T20:57:52Z

@benfred , do you mind if I take this PR and branch? I'll work the README into an introduction for the doc. I suspect that I'll find something nitpicky too.

Oh, for example, I'm inclined to use "Merlin Core" when the words are intended for humans and merlin-core when the intended audience is pip or (I guess...) conda.

nvidia-merlin-bot · 2022-04-01T03:15:24Z

Click to view CI Results

GitHub pull request #53 of commit 69743efbe114bac17a51ce539cb79e7e05005cda, no merge conflicts.
Running as SYSTEM
Setting status of 69743efbe114bac17a51ce539cb79e7e05005cda to PENDING with url https://10.20.13.93:8080/job/merlin_core/3/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_core
using credential ce87ff3c-94f0-400a-8303-cb4acb4918b5
 > 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/core # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/core
 > git --version # timeout=10
using GIT_ASKPASS to set credentials login for merlin-systems username and pass
 > git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/core +refs/pull/53/*:refs/remotes/origin/pr/53/* # timeout=10
 > git rev-parse 69743efbe114bac17a51ce539cb79e7e05005cda^{commit} # timeout=10
Checking out Revision 69743efbe114bac17a51ce539cb79e7e05005cda (detached)
 > git config core.sparsecheckout # timeout=10
 > git checkout -f 69743efbe114bac17a51ce539cb79e7e05005cda # timeout=10
Commit message: "Merge branch 'main' into readme_updates"
 > git rev-list --no-walk b400155d8dde6560f024366ee41c0a045ca53c4a # timeout=10
[merlin_core] $ /bin/bash /tmp/jenkins5211980999684332304.sh
Looking in indexes: https://pypi.org/simple, https://pypi.ngc.nvidia.com
Requirement already satisfied: setuptools in /usr/local/lib/python3.8/dist-packages (61.3.0)
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_core/core, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 337 items / 1 skipped
tests/unit/core/test_dispatch.py ..                                      [  0%]

tests/unit/dag/test_base_operator.py ....                                [  1%]

tests/unit/dag/test_column_selector.py ..........................        [  9%]

tests/unit/dag/test_tags.py ......                                       [ 11%]

tests/unit/dag/ops/test_selection.py ...                                 [ 12%]

tests/unit/io/test_io.py ............................................... [ 26%]

................................................................         [ 45%]

tests/unit/schema/test_column_schemas.py ............................... [ 54%]

........................................................................ [ 75%]

........................................................................ [ 97%]

[ 97%]

tests/unit/schema/test_schema_io.py ..                                   [ 97%]

tests/unit/utils/test_utils.py ........                                  [100%]
=============================== warnings summary ===============================

tests/unit/dag/test_base_operator.py: 4 warnings

tests/unit/io/test_io.py: 73 warnings

/usr/lib/python3.8/site-packages/cudf/core/dataframe.py:1253: UserWarning: The deep parameter is ignored and is only included for pandas compatibility.

warnings.warn(
tests/unit/io/test_io.py: 145 warnings

/var/jenkins_home/.local/lib/python3.8/site-packages/partd-1.2.0-py3.8.egg/partd/pandas.py:113: DeprecationWarning: The Index._get_attributes_dict method is deprecated, and will be removed in a future version

header = (type(ind), ind._get_attributes_dict(), values.dtype, cat)
tests/unit/io/test_io.py::test_validate_and_regenerate_dataset

/var/jenkins_home/workspace/merlin_core/core/merlin/io/parquet.py:535: DeprecationWarning: 'ParquetDataset.pieces' attribute is deprecated as of pyarrow 5.0.0 and will be removed in a future version. Specify 'use_legacy_dataset=False' while constructing the ParquetDataset, and then use the '.fragments' attribute instead.

paths = [p.path for p in pa_dataset.pieces]
tests/unit/utils/test_utils.py::test_nvt_distributed[True-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 38185 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[True-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 42877 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 37763 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 42225 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 43361 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 42313 instead

warnings.warn(
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html

================ 337 passed, 1 skipped, 229 warnings in 52.00s =================

Performing Post build task...

Match found for : : True

Logical operation result is TRUE

Running script  : #!/bin/bash

cd /var/jenkins_home/

CUDA_VISIBLE_DEVICES=1 python test_res_push.py "https://api.GitHub.com/repos/NVIDIA-Merlin/core/issues/$ghprbPullId/comments" "/var/jenkins_home/jobs/$JOB_NAME/builds/$BUILD_NUMBER/log"

[merlin_core] $ /bin/bash /tmp/jenkins3201184215669188792.sh

nvidia-merlin-bot · 2022-04-01T13:05:01Z

Click to view CI Results

GitHub pull request #53 of commit b614bccf1c5835399ed955e6e1679117f7db5de0, no merge conflicts.
Running as SYSTEM
Setting status of b614bccf1c5835399ed955e6e1679117f7db5de0 to PENDING with url https://10.20.13.93:8080/job/merlin_core/4/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_core
using credential ce87ff3c-94f0-400a-8303-cb4acb4918b5
 > 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/core # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/core
 > git --version # timeout=10
using GIT_ASKPASS to set credentials login for merlin-systems username and pass
 > git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/core +refs/pull/53/*:refs/remotes/origin/pr/53/* # timeout=10
 > git rev-parse b614bccf1c5835399ed955e6e1679117f7db5de0^{commit} # timeout=10
Checking out Revision b614bccf1c5835399ed955e6e1679117f7db5de0 (detached)
 > git config core.sparsecheckout # timeout=10
 > git checkout -f b614bccf1c5835399ed955e6e1679117f7db5de0 # timeout=10
Commit message: "docs: Reuse README as docs introduction"
 > git rev-list --no-walk 69743efbe114bac17a51ce539cb79e7e05005cda # timeout=10
[merlin_core] $ /bin/bash /tmp/jenkins1454544670260285175.sh
Looking in indexes: https://pypi.org/simple, https://pypi.ngc.nvidia.com
Requirement already satisfied: setuptools in /usr/local/lib/python3.8/dist-packages (61.3.0)
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_core/core, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 337 items / 1 skipped
tests/unit/core/test_dispatch.py ..                                      [  0%]

tests/unit/dag/test_base_operator.py ....                                [  1%]

tests/unit/dag/test_column_selector.py ..........................        [  9%]

tests/unit/dag/test_tags.py ......                                       [ 11%]

tests/unit/dag/ops/test_selection.py ...                                 [ 12%]

tests/unit/io/test_io.py ............................................... [ 26%]

................................................................         [ 45%]

tests/unit/schema/test_column_schemas.py ............................... [ 54%]

........................................................................ [ 75%]

........................................................................ [ 97%]

[ 97%]

tests/unit/schema/test_schema_io.py ..                                   [ 97%]

tests/unit/utils/test_utils.py ........                                  [100%]
=============================== warnings summary ===============================

tests/unit/dag/test_base_operator.py: 4 warnings

tests/unit/io/test_io.py: 73 warnings

/usr/lib/python3.8/site-packages/cudf/core/dataframe.py:1253: UserWarning: The deep parameter is ignored and is only included for pandas compatibility.

warnings.warn(
tests/unit/io/test_io.py: 145 warnings

/var/jenkins_home/.local/lib/python3.8/site-packages/partd-1.2.0-py3.8.egg/partd/pandas.py:113: DeprecationWarning: The Index._get_attributes_dict method is deprecated, and will be removed in a future version

header = (type(ind), ind._get_attributes_dict(), values.dtype, cat)
tests/unit/io/test_io.py::test_validate_and_regenerate_dataset

/var/jenkins_home/workspace/merlin_core/core/merlin/io/parquet.py:535: DeprecationWarning: 'ParquetDataset.pieces' attribute is deprecated as of pyarrow 5.0.0 and will be removed in a future version. Specify 'use_legacy_dataset=False' while constructing the ParquetDataset, and then use the '.fragments' attribute instead.

paths = [p.path for p in pa_dataset.pieces]
tests/unit/utils/test_utils.py::test_nvt_distributed[True-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 44983 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[True-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 40215 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 44883 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 45931 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 43175 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 45157 instead

warnings.warn(
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html

================ 337 passed, 1 skipped, 229 warnings in 52.83s =================

Performing Post build task...

Match found for : : True

Logical operation result is TRUE

Running script  : #!/bin/bash

cd /var/jenkins_home/

CUDA_VISIBLE_DEVICES=1 python test_res_push.py "https://api.GitHub.com/repos/NVIDIA-Merlin/core/issues/$ghprbPullId/comments" "/var/jenkins_home/jobs/$JOB_NAME/builds/$BUILD_NUMBER/log"

[merlin_core] $ /bin/bash /tmp/jenkins4856582183799159360.sh

* Rather than repeat the table of images (that wasn't such a smart suggestion), I included a URL to the Merlin Containers page. Updates to READMEs in other repos coming soonish.

nvidia-merlin-bot · 2022-04-01T13:11:26Z

Click to view CI Results

GitHub pull request #53 of commit 25751fe77a50b8353378f675c04337de26cbbcd5, no merge conflicts.
Running as SYSTEM
Setting status of 25751fe77a50b8353378f675c04337de26cbbcd5 to PENDING with url https://10.20.13.93:8080/job/merlin_core/5/console and message: 'Pending'
Using context: Jenkins
Building on master in workspace /var/jenkins_home/workspace/merlin_core
using credential ce87ff3c-94f0-400a-8303-cb4acb4918b5
 > 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/core # timeout=10
Fetching upstream changes from https://github.com/NVIDIA-Merlin/core
 > git --version # timeout=10
using GIT_ASKPASS to set credentials login for merlin-systems username and pass
 > git fetch --tags --force --progress -- https://github.com/NVIDIA-Merlin/core +refs/pull/53/*:refs/remotes/origin/pr/53/* # timeout=10
 > git rev-parse 25751fe77a50b8353378f675c04337de26cbbcd5^{commit} # timeout=10
Checking out Revision 25751fe77a50b8353378f675c04337de26cbbcd5 (detached)
 > git config core.sparsecheckout # timeout=10
 > git checkout -f 25751fe77a50b8353378f675c04337de26cbbcd5 # timeout=10
Commit message: "docs: Reuse README as docs introduction"
 > git rev-list --no-walk b614bccf1c5835399ed955e6e1679117f7db5de0 # timeout=10
[merlin_core] $ /bin/bash /tmp/jenkins2082839815955728354.sh
Looking in indexes: https://pypi.org/simple, https://pypi.ngc.nvidia.com
Requirement already satisfied: setuptools in /usr/local/lib/python3.8/dist-packages (61.3.0)
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
rootdir: /var/jenkins_home/workspace/merlin_core/core, configfile: pyproject.toml
plugins: xdist-2.5.0, forked-1.4.0, cov-3.0.0
collected 337 items / 1 skipped
tests/unit/core/test_dispatch.py ..                                      [  0%]

tests/unit/dag/test_base_operator.py ....                                [  1%]

tests/unit/dag/test_column_selector.py ..........................        [  9%]

tests/unit/dag/test_tags.py ......                                       [ 11%]

tests/unit/dag/ops/test_selection.py ...                                 [ 12%]

tests/unit/io/test_io.py ............................................... [ 26%]

................................................................         [ 45%]

tests/unit/schema/test_column_schemas.py ............................... [ 54%]

........................................................................ [ 75%]

........................................................................ [ 97%]

[ 97%]

tests/unit/schema/test_schema_io.py ..                                   [ 97%]

tests/unit/utils/test_utils.py ........                                  [100%]
=============================== warnings summary ===============================

tests/unit/dag/test_base_operator.py: 4 warnings

tests/unit/io/test_io.py: 73 warnings

/usr/lib/python3.8/site-packages/cudf/core/dataframe.py:1253: UserWarning: The deep parameter is ignored and is only included for pandas compatibility.

warnings.warn(
tests/unit/io/test_io.py: 145 warnings

/var/jenkins_home/.local/lib/python3.8/site-packages/partd-1.2.0-py3.8.egg/partd/pandas.py:113: DeprecationWarning: The Index._get_attributes_dict method is deprecated, and will be removed in a future version

header = (type(ind), ind._get_attributes_dict(), values.dtype, cat)
tests/unit/io/test_io.py::test_validate_and_regenerate_dataset

/var/jenkins_home/workspace/merlin_core/core/merlin/io/parquet.py:535: DeprecationWarning: 'ParquetDataset.pieces' attribute is deprecated as of pyarrow 5.0.0 and will be removed in a future version. Specify 'use_legacy_dataset=False' while constructing the ParquetDataset, and then use the '.fragments' attribute instead.

paths = [p.path for p in pa_dataset.pieces]
tests/unit/utils/test_utils.py::test_nvt_distributed[True-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 33111 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[True-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 41211 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 42683 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed[False-False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 45689 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[True]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 45923 instead

warnings.warn(
tests/unit/utils/test_utils.py::test_nvt_distributed_force[False]

/var/jenkins_home/.local/lib/python3.8/site-packages/distributed/node.py:160: UserWarning: Port 8787 is already in use.

Perhaps you already have a cluster running?

Hosting the HTTP server on port 44797 instead

warnings.warn(
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html

================ 337 passed, 1 skipped, 229 warnings in 52.88s =================

Performing Post build task...

Match found for : : True

Logical operation result is TRUE

Running script  : #!/bin/bash

cd /var/jenkins_home/

CUDA_VISIBLE_DEVICES=1 python test_res_push.py "https://api.GitHub.com/repos/NVIDIA-Merlin/core/issues/$ghprbPullId/comments" "/var/jenkins_home/jobs/$JOB_NAME/builds/$BUILD_NUMBER/log"

[merlin_core] $ /bin/bash /tmp/jenkins2656933606094155876.sh

README updates

5fe822e

* Add badges * Add Feedback/support section * Add docker install instructions

karlhigley added this to the Merlin 22.04 milestone Mar 31, 2022

karlhigley added the documentation Improvements or additions to documentation label Mar 31, 2022

karlhigley assigned benfred Mar 31, 2022

karlhigley requested a review from mikemckiernan March 31, 2022 17:49

Merge branch 'main' into readme_updates

69743ef

docs: Reuse README as docs introduction

25751fe

* Rather than repeat the table of images (that wasn't such a smart suggestion), I included a URL to the Merlin Containers page. Updates to READMEs in other repos coming soonish.

mikemckiernan force-pushed the readme_updates branch from b614bcc to 25751fe Compare April 1, 2022 13:10

mikemckiernan requested a review from karlhigley April 1, 2022 13:14

karlhigley approved these changes Apr 1, 2022

View reviewed changes

karlhigley merged commit dae4625 into main Apr 1, 2022

karlhigley deleted the readme_updates branch January 13, 2023 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README updates#53

README updates#53
karlhigley merged 3 commits intomainfrom
readme_updates

benfred commented Mar 31, 2022

Uh oh!

github-actions bot commented Mar 31, 2022

Uh oh!

mikemckiernan commented Mar 31, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

benfred commented Mar 31, 2022

Uh oh!

github-actions bot commented Mar 31, 2022

Documentation preview

Uh oh!

mikemckiernan commented Mar 31, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

nvidia-merlin-bot commented Apr 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants