Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Root path is undefined #11970

Closed
vandanavk wants to merge 1 commit into from
Closed

Root path is undefined #11970

vandanavk wants to merge 1 commit into from

Conversation

@vandanavk
Copy link
Contributor

@vandanavk vandanavk commented Aug 1, 2018 •
edited
Loading

Description

root_path in build_r_docs is undefined. Since the
function call is commented out, this wasn't caught. Fixing
the path to avoid error in future.

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Fixed root path in build R docs

Comments

@aaronmarkham

@vandanavk
Root path is undefined
6cf5b57 
root_path in build_r_docs is undefined. Since the
function call is commented out, this wasn't caught. Fixing
the path to avoid error in future.
@vandanavk vandanavk requested a review from szha as a code owner August 1, 2018 16:28
@marcoabreu
Copy link
Contributor

marcoabreu commented Aug 1, 2018

Why are we not building the R docs/

@vandanavk
Copy link
Contributor Author

vandanavk commented Aug 1, 2018

It was commented out by default - wasn't enabled later.
Building R docs fails on my machine though. @aaronmarkham have you been able to build R docs on your setup?

@vandanavk
Copy link
Contributor Author

vandanavk commented Aug 1, 2018

@cclauss

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Aug 1, 2018

Actually, ran into this today on another PR I'm working on. I fixed it. I can make it a separate PR if you want something right away... otherwise it'll come in the docs build pipeline refactor I'm doing.

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Aug 1, 2018

@marcoabreu The reason, according to the comment in mxdoc.py is that the latex requirement for R is too "heavy". It seems true, because I ran out of disk space on my instance while installing the dependencies.

These include:

sudo apt-get install \
    texinfo \
    texlive \
    texlive-fonts-extra \

To add this into a PR, it would seem I'd need to update the CI/install/R.sh and have it load these quite large deps.

WDYT about that?

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Aug 1, 2018

I used a different approach on my fix, but I can align with this one if you guys plan to get this merged quickly. BTW, this will fail upon a second run because the file will already exist... so I made further changes to fix that... plus I'm massively changing this file anyways, but my PR should overlay on top of this just fine.
Please let me know what you want to do.

@aaronmarkham aaronmarkham mentioned this pull request Aug 2, 2018
Merged
2 tasks
@marcoabreu
Copy link
Contributor

marcoabreu commented Aug 2, 2018

No need for a rush, just take your time and do it right :)

About how much additional disk space are we talking here?

@vandanavk
Copy link
Contributor Author

vandanavk commented Aug 2, 2018

Closing this PR - Aaron's PR #11990 takes care of this.

@vandanavk vandanavk closed this Aug 2, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@szha szha Awaiting requested review from szha szha is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@vandanavk @marcoabreu @aaronmarkham