Cudf: [BUG] formatting issues in libcudf documentation in rapids.ai
Describe the bug
codein libcudf documentation has unnecessary new lines.
https://docs.rapids.ai/api/libcudf/nightly/namespacecudf_1_1dictionary.html
- texts in images are formatted as boxes.
https://docs.rapids.ai/api/libcudf/nightly/classcudf_1_1experimental_1_1io_1_1detail_1_1avro_1_1metadata.html
(issue is most likely due to build image graphviz font dependency issue)
Local docs_cudf build does not have these 2 issues.
Steps/Code to reproduce bug
Visit https://docs.rapids.ai/api/libcudf/nightly/namespacecudf_1_1dictionary.html
Visit https://docs.rapids.ai/api/libcudf/nightly/classcudf_1_1experimental_1_1io_1_1detail_1_1avro_1_1metadata.html
Expected behavior
same rendering as local build rendering.
fonts displayed correctly in images, code without extra empty new lines.
Environment overview
- Environment location: Bare-metal
Environment details
Click here to see environment details
**git***
commit 9ded196cd45adb98de4eeea3333d1a43118ab149 (HEAD -> bug-scalar_iter_avoid_host_copy, karthikeyann/bug-scalar_iter_avoid_host_copy)
Author: Karthikeyan Natarajan <[email protected]>
Date: Fri May 1 01:24:33 2020 +0530
style fix, document throw host dereferencing
**git submodules***
b165e1fb11eeea64ccf95053e40f2424312599cc thirdparty/cub (v1.7.1)
e3f867027c1d9603b5a677795900465b9fac9cb8 thirdparty/jitify (remotes/origin/HEAD)
cdcda484d0c7db114ea29c3b33429de5756ecfd8 thirdparty/libcudacxx (0.8.1-99-gcdcda48)
a97a7380c76346c22bb67b93695bed19592afad2 thirdparty/libcudacxx/libcxx (heads/rapidsai-interop)
***OS Information***
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=18.04
DISTRIB_CODENAME=bionic
DISTRIB_DESCRIPTION="Ubuntu 18.04.3 LTS"
NAME="Ubuntu"
VERSION="18.04.3 LTS (Bionic Beaver)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 18.04.3 LTS"
VERSION_ID="18.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=bionic
UBUNTU_CODENAME=bionic
Linux knataraj-ws 4.15.0-91-generic #92-Ubuntu SMP Fri Feb 28 11:09:48 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
***GPU Information***
Fri May 1 02:08:18 2020
+-----------------------------------------------------------------------------+
| NVIDIA-SMI 410.48 Driver Version: 410.48 |
|-------------------------------+----------------------+----------------------+
| GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
| Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
|===============================+======================+======================|
| 0 Quadro GV100 Off | 00000000:15:00.0 Off | Off |
| 37% 50C P2 40W / 250W | 0MiB / 32478MiB | 0% Default |
+-------------------------------+----------------------+----------------------+
| 1 Quadro GV100 Off | 00000000:2D:00.0 On | Off |
| 43% 57C P0 42W / 250W | 212MiB / 32468MiB | 1% Default |
+-------------------------------+----------------------+----------------------+
+-----------------------------------------------------------------------------+
| Processes: GPU Memory |
| GPU PID Type Process name Usage |
|=============================================================================|
| 1 1602 G /usr/lib/xorg/Xorg 127MiB |
| 1 1826 G /usr/bin/gnome-shell 83MiB |
+-----------------------------------------------------------------------------+
***CPU***
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
CPU(s): 12
On-line CPU(s) list: 0-11
Thread(s) per core: 2
Core(s) per socket: 6
Socket(s): 1
NUMA node(s): 1
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6128 CPU @ 3.40GHz
Stepping: 4
CPU MHz: 3700.000
CPU max MHz: 3700.0000
CPU min MHz: 1200.0000
BogoMIPS: 6800.00
Virtualization: VT-x
L1d cache: 32K
L1i cache: 32K
L2 cache: 1024K
L3 cache: 19712K
NUMA node0 CPU(s): 0-11
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d
***CMake***
/home/karthikeyan/miniconda3/envs/cudf_dev/bin/cmake
cmake version 3.17.0
CMake suite maintained and supported by Kitware (kitware.com/cmake).
***g++***
/usr/bin/g++
g++ (Ubuntu 5.5.0-12ubuntu1) 5.5.0 20171010
Copyright (C) 2015 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
***nvcc***
/usr/local/cuda-10.0/bin/nvcc
nvcc: NVIDIA (R) Cuda compiler driver
Copyright (c) 2005-2018 NVIDIA Corporation
Built on Sat_Aug_25_21:08:01_CDT_2018
Cuda compilation tools, release 10.0, V10.0.130
***Python***
/home/karthikeyan/miniconda3/envs/cudf_dev/bin/python
Python 3.7.6
***Environment Variables***
PATH : /home/karthikeyan/miniconda3/envs/cudf_dev/bin:/home/karthikeyan/miniconda3/condabin:/usr/local/cuda-10.0/bin:/home/karthikeyan/.vscode-server/bin/ff915844119ce9485abfe8aa9076ec76b5300ddd/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/usr/local/cuda/bin:/home/karthikeyan/miniconda3/bin:/home/karthikeyan/.local/bin
LD_LIBRARY_PATH : /usr/local/cuda-10.0/lib64:/home/karthikeyan/4cudf/cpp/build
NUMBAPRO_NVVM :
NUMBAPRO_LIBDEVICE :
CONDA_PREFIX : /home/karthikeyan/miniconda3/envs/cudf_dev
PYTHON_PATH :
***conda packages***
/home/karthikeyan/miniconda3/condabin/conda
# packages in environment at /home/karthikeyan/miniconda3/envs/cudf_dev:
#
# Name Version Build Channel
_libgcc_mutex 0.1 conda_forge conda-forge
_openmp_mutex 4.5 1_llvm conda-forge
_py-xgboost-mutex 2.0 cpu_0 conda-forge
alabaster 0.7.12 py_0 conda-forge
appdirs 1.4.3 py_1 conda-forge
arrow-cpp 0.15.0 py37h090bef1_2 conda-forge
attrs 19.3.0 py_0 conda-forge
babel 2.8.0 py_0 conda-forge
backcall 0.1.0 py_0 conda-forge
black 19.10b0 py37_0 conda-forge
blas 2.15 openblas conda-forge
bleach 3.1.1 py_0 conda-forge
bokeh 1.4.0 py37_0 conda-forge
boost-cpp 1.70.0 h8e57a91_2 conda-forge
brotli 1.0.7 he1b5a44_1000 conda-forge
bzip2 1.0.8 h516909a_2 conda-forge
c-ares 1.15.0 h516909a_1001 conda-forge
ca-certificates 2020.4.5.1 hecc5488_0 conda-forge
certifi 2020.4.5.1 py37hc8dfbb8_0 conda-forge
cffi 1.14.0 py37hd463f26_0 conda-forge
cfgv 3.0.0 py_0 conda-forge
chardet 3.0.4 py37_1003 conda-forge
clang 8.0.1 hc9558a2_2 conda-forge
clang-tools 8.0.1 hc9558a2_2 conda-forge
clangxx 8.0.1 2 conda-forge
click 7.0 py_0 conda-forge
cloudpickle 1.3.0 py_0 conda-forge
cmake 3.17.0 h28c56e5_0 conda-forge
cmake_setuptools 0.1.3 py_0 rapidsai
commonmark 0.9.1 py_0 conda-forge
cryptography 2.8 py37h72c5cf5_1 conda-forge
cudatoolkit 10.0.130 0 nvidia
cudnn 7.6.0 cuda10.0_0 nvidia
cupy 7.3.0 py37h658377b_0 conda-forge
cython 0.29.16 py37h3340039_0 conda-forge
cytoolz 0.10.1 py37h516909a_0 conda-forge
dask 2.10.1+4.gf0b8bd47 pypi_0 pypi
dask-core 2.14.0 py_0 conda-forge
dask-xgboost 0.1.10 py_0 conda-forge
decorator 4.4.2 py_0 conda-forge
defusedxml 0.6.0 py_0 conda-forge
distributed 2.11.0+23.ge619fc99 pypi_0 pypi
dlpack 0.2 he1b5a44_1 conda-forge
docutils 0.16 py37_0 conda-forge
double-conversion 3.1.5 he1b5a44_2 conda-forge
doxygen 1.8.16 hd1b7508_1 conda-forge
editdistance 0.5.3 py37he1b5a44_0 conda-forge
entrypoints 0.3 py37_1000 conda-forge
expat 2.2.9 he1b5a44_2 conda-forge
fastavro 0.23.1 py37h8f50634_0 conda-forge
fastrlock 0.4 py37he1b5a44_1000 conda-forge
flake8 3.7.9 py37hc8dfbb8_1 conda-forge
flatbuffers 1.12.0 he1b5a44_0 conda-forge
freetype 2.10.0 he983fc9_1 conda-forge
fsspec 0.7.2 py_0 conda-forge
future 0.18.2 py37_0 conda-forge
gflags 2.2.2 he1b5a44_1002 conda-forge
glog 0.4.0 he1b5a44_1 conda-forge
gmp 6.2.0 he1b5a44_2 conda-forge
grpc-cpp 1.23.0 h18db393_0 conda-forge
heapdict 1.0.1 py_0 conda-forge
hypothesis 5.9.0 py_0 conda-forge
icu 64.2 he1b5a44_1 conda-forge
identify 1.4.11 py_0 conda-forge
idna 2.9 py_1 conda-forge
imagesize 1.2.0 py_0 conda-forge
importlib_metadata 1.5.0 py37_0 conda-forge
ipykernel 5.1.4 py37h5ca1d4c_0 conda-forge
ipython 7.13.0 py37hc8dfbb8_2 conda-forge
ipython_genutils 0.2.0 py_1 conda-forge
isort 4.3.21 py37hc8dfbb8_1 conda-forge
jedi 0.16.0 py37_0 conda-forge
jinja2 2.11.1 py_0 conda-forge
joblib 0.14.1 py_0 conda-forge
jpeg 9c h14c3975_1001 conda-forge
jsonschema 3.2.0 py37_0 conda-forge
jupyter_client 6.0.0 py_0 conda-forge
jupyter_core 4.6.3 py37_0 conda-forge
krb5 1.16.4 h2fd8d38_0 conda-forge
ld_impl_linux-64 2.33.1 h53a641e_8 conda-forge
libblas 3.8.0 15_openblas conda-forge
libcblas 3.8.0 15_openblas conda-forge
libcurl 7.68.0 hda55be3_0 conda-forge
libedit 3.1.20170329 hf8c457e_1001 conda-forge
libevent 2.1.10 h72c5cf5_0 conda-forge
libffi 3.2.1 he1b5a44_1006 conda-forge
libgcc-ng 9.2.0 h24d8f2e_2 conda-forge
libgfortran-ng 7.3.0 hdf63c60_5 conda-forge
libiconv 1.15 h516909a_1006 conda-forge
liblapack 3.8.0 15_openblas conda-forge
liblapacke 3.8.0 15_openblas conda-forge
libllvm8 8.0.1 hc9558a2_0 conda-forge
libopenblas 0.3.8 h5ec1e0e_0 conda-forge
libpng 1.6.37 hed695b0_0 conda-forge
libprotobuf 3.8.0 h8b12597_0 conda-forge
librmm 0.14.0a200408 cuda10.0_252 rapidsai-nightly
libsodium 1.0.17 h516909a_0 conda-forge
libssh2 1.8.2 h22169c7_2 conda-forge
libstdcxx-ng 9.2.0 hdf63c60_2 conda-forge
libtiff 4.1.0 hfc65ed5_0 conda-forge
libuv 1.34.0 h516909a_0 conda-forge
libxgboost 1.0.2 he1b5a44_0 conda-forge
llvm-openmp 9.0.1 hc9558a2_2 conda-forge
llvmlite 0.31.0 py37h8b12597_0 conda-forge
locket 0.2.0 py_2 conda-forge
lz4-c 1.8.3 he1b5a44_1001 conda-forge
markdown 3.0.1 pypi_0 pypi
markupsafe 1.1.1 py37h516909a_0 conda-forge
mccabe 0.6.1 py_1 conda-forge
mistune 0.8.4 py37h516909a_1000 conda-forge
more-itertools 8.2.0 py_0 conda-forge
msgpack-python 1.0.0 py37hc9558a2_0 conda-forge
mypy_extensions 0.4.3 py37_0 conda-forge
nbconvert 5.6.1 py37_0 conda-forge
nbformat 5.0.4 py_0 conda-forge
nbsphinx 0.6.0 pyh9f0ad1d_0 conda-forge
nccl 2.4.6.1 cuda10.0_0 nvidia
ncurses 6.1 hf484d3e_1002 conda-forge
nodeenv 1.3.5 py_0 conda-forge
notebook 6.0.3 py37_0 conda-forge
numba 0.48.0 py37hb3f55d8_0 conda-forge
numpy 1.18.1 py37h95a1406_0 conda-forge
numpydoc 0.9.2 py_0 conda-forge
olefile 0.46 py_0 conda-forge
openssl 1.1.1g h516909a_0 conda-forge
packaging 20.1 py_0 conda-forge
pandas 0.25.3 py37hb3f55d8_0 conda-forge
pandoc 1.19.2 0 conda-forge
pandocfilters 1.4.2 py_1 conda-forge
parquet-cpp 1.5.1 2 conda-forge
parso 0.6.2 py_0 conda-forge
partd 1.1.0 py_0 conda-forge
pathspec 0.7.0 py_0 conda-forge
pexpect 4.8.0 py37_0 conda-forge
pickleshare 0.7.5 py37_1000 conda-forge
pillow 7.0.0 py37hefe7db6_0 conda-forge
pip 20.0.2 py_2 conda-forge
pluggy 0.13.0 py37_0 conda-forge
pre-commit 2.1.1 py37_0 conda-forge
pre_commit 2.1.1 0 conda-forge
prometheus_client 0.7.1 py_0 conda-forge
prompt-toolkit 3.0.5 py_0 conda-forge
prompt_toolkit 3.0.3 py_0 conda-forge
psutil 5.7.0 py37h516909a_0 conda-forge
ptyprocess 0.6.0 py_1001 conda-forge
py 1.8.1 py_0 conda-forge
py-xgboost 1.0.2 py37hc8dfbb8_0 conda-forge
pyarrow 0.15.0 py37h8b68381_1 conda-forge
pycodestyle 2.5.0 py_0 conda-forge
pycparser 2.20 py_0 conda-forge
pyflakes 2.1.1 py_0 conda-forge
pygments 2.5.2 py_0 conda-forge
pyopenssl 19.1.0 py_1 conda-forge
pyparsing 2.4.6 py_0 conda-forge
pyrsistent 0.15.7 py37h516909a_0 conda-forge
pysocks 1.7.1 py37_0 conda-forge
pytest 5.4.1 py37hc8dfbb8_0 conda-forge
pytest-repeat 0.8.0 pypi_0 pypi
python 3.7.6 h8356626_5_cpython conda-forge
python-dateutil 2.8.1 py_0 conda-forge
python_abi 3.7 1_cp37m conda-forge
pytz 2019.3 py_0 conda-forge
pyyaml 5.3 py37h516909a_0 conda-forge
pyzmq 19.0.0 py37h1768529_0 conda-forge
rapidjson 1.1.0 he1b5a44_1002 conda-forge
re2 2020.03.03 he1b5a44_0 conda-forge
readline 8.0 hf8c457e_0 conda-forge
recommonmark 0.6.0 py_0 conda-forge
regex 2020.2.20 py37h516909a_0 conda-forge
requests 2.23.0 py37_0 conda-forge
rhash 1.3.6 h14c3975_1001 conda-forge
rmm 0.14.0a200415 py37_252 rapidsai-nightly
scikit-learn 0.22.2.post1 py37hcdab131_0 conda-forge
scipy 1.3.2 py37he2b7bc3_0
send2trash 1.5.0 py_0 conda-forge
setuptools 45.2.0 py37_0 conda-forge
six 1.14.0 py37_0 conda-forge
snappy 1.1.7 he1b5a44_1003 conda-forge
snowballstemmer 2.0.0 py_0 conda-forge
sortedcontainers 2.1.0 py_0 conda-forge
sphinx 3.0.1 py_0 conda-forge
sphinx-markdown-tables 0.0.12 pypi_0 pypi
sphinx_rtd_theme 0.4.3 py_0 conda-forge
sphinxcontrib-applehelp 1.0.2 py_0 conda-forge
sphinxcontrib-devhelp 1.0.2 py_0 conda-forge
sphinxcontrib-htmlhelp 1.0.3 py_0 conda-forge
sphinxcontrib-jsmath 1.0.1 py_0 conda-forge
sphinxcontrib-qthelp 1.0.3 py_0 conda-forge
sphinxcontrib-serializinghtml 1.1.4 py_0 conda-forge
sphinxcontrib-websupport 1.2.1 pyh9f0ad1d_0 conda-forge
sqlite 3.30.1 hcee41ef_0 conda-forge
streamz 0.5.2 pypi_0 pypi
tblib 1.6.0 py_0 conda-forge
terminado 0.8.3 py37_0 conda-forge
testpath 0.4.4 py_0 conda-forge
thrift-cpp 0.12.0 hf3afdfd_1004 conda-forge
tk 8.6.10 hed695b0_0 conda-forge
toml 0.10.0 py_0 conda-forge
toolz 0.10.0 py_0 conda-forge
tornado 6.0.4 py37h516909a_0 conda-forge
traitlets 4.3.3 py37_0 conda-forge
typed-ast 1.4.1 py37h516909a_0 conda-forge
typing_extensions 3.7.4.1 py37_0 conda-forge
uriparser 0.9.3 he1b5a44_1 conda-forge
urllib3 1.25.7 py37_0 conda-forge
virtualenv 16.7.5 py_0 conda-forge
wcwidth 0.1.8 py_0 conda-forge
webencodings 0.5.1 py_1 conda-forge
wheel 0.34.2 py_1 conda-forge
xgboost 1.0.2 py37h3340039_0 conda-forge
xz 5.2.4 h14c3975_1001 conda-forge
yaml 0.2.2 h516909a_1 conda-forge
zeromq 4.3.2 he1b5a44_2 conda-forge
zict 2.0.0 py_0 conda-forge
zipp 3.1.0 py_0 conda-forge
zlib 1.2.11 h516909a_1006 conda-forge
zstd 1.4.3 h3b9ef0a_0 conda-forge
karthikeyann
All 9 comments
code section of local docs_cudf build
image with text rendered in local docs_cudf build.
karthikeyann
on 30 Apr 2020
This is an existing problem on the stable-0.13 docs as well. Here are a couple of examples:
https://docs.rapids.ai/api/libcudf/stable/namespacecudf.html#a6c828f318cb2c14c8ac0567f5084d1e7
https://docs.rapids.ai/api/libcudf/stable/structcudf_1_1avro__read__arg.html
So there is a problem with how this is built in the publish process.
davidwendt
on 1 May 2020
The generated output for the website seems to include alot of extra newline characters that are not produced when running doxygen locally on Linux or Windows. Here is a picture showing the extra newlines appearing not only in the code blocks but also in the <p> text elements.
davidwendt
on 1 May 2020
As for the diagrams, there are very few public classes and those do not have any complicated hierarchy. Most of libcudf is C-function APIs. So my inclination is just to disable this for now. Maybe we can revisit this once the legacy is removed and the experimental namespace is resolved.
davidwendt
on 1 May 2020
Is the font issue fixed in docker image?
--
Karthikeyan Natarajan
From: AJ Schmidt notifications@github.com
Sent: Monday, May 18, 2020 10:50:07 PM
To: rapidsai/cudf cudf@noreply.github.com
Cc: Karthikeyan Natarajan knataraj@nvidia.com; Author author@noreply.github.com
Subject: Re: [rapidsai/cudf] [BUG] formatting issues in libcudf documentation in rapids.ai (#5063)
Closed #5063https://github.com/rapidsai/cudf/issues/5063 via rapidsai/docs#84https://github.com/rapidsai/docs/pull/84.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHubhttps://github.com/rapidsai/cudf/issues/5063#event-3348342292, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABRQGEESVUZVQ7GB4M5BCULRSFU4PANCNFSM4MWTKPWQ.
This email message is for the sole use of the intended recipient(s) and may contain
confidential information. Any unauthorized review, use, disclosure or distribution
is prohibited. If you are not the intended recipient, please contact the sender by
reply email and destroy all copies of the original message.
karthikeyann
on 18 May 2020
@karthikeyann, nope not yet. This issue was closed accidentally by GitHub. I believe I fixed the whitespace issue in this PR https://github.com/rapidsai/docs/pull/84. I'm running some tests now to verify the changes.
ajschmidt8
on 18 May 2020
@karthikeyann, this recently merged PR should fix the icon issue https://github.com/rapidsai/build/pull/87.
Once the containers are rebuilt, I'll rebuild the docs and we should see everything correctly reflected on the site.
ajschmidt8
on 22 May 2020
@karthikeyann, cudf 0.14 docs have been rebuilt successfully.
0.13 still needs to be rebuilt, but this will likely happen later in the week. feel free to confirm the changes with the links above. you may need to clear your browser cache.
ajschmidt8
on 27 May 2020
👍2
Was this page helpful?
0 / 5 - 0 ratings
Related issues
kkraus14
·
3Comments
c-jamie
·
3Comments
randerzander
·
3Comments
galipremsagar
·
3Comments
AjayThorve
·
3Comments
Most helpful comment
0.13 has also been rebuilt now.