-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set up static html documentation for R package #26
Comments
FYI I'll be working on this soon. Also cc @missaugustina since you are working on docs in #227 and just realized that you are involved in the R world as well. I don't think there will be conflict with Python docs though since it's totally independent. |
I actually use Rstudio's Tensorflow/Keras libs so yeah I can definitely help here. (edited) I just noticed the R-package directory at the parent level of this repo. What's the vision for Tensorflow IO as an R-package? Would you or could you recommend someone to do a quick hangouts call with me for a high level tour of the repo since I'm so new to this project? |
@missaugustina The R package we took for tfio is actually the same as what we did for the other TensorFlow R packages, through reticulate package. I believe the code structure would be easier to understand once you get familiar with reticulate. The R package consists of thin wrappers of the Python API. We are definitely lack of documentations and examples though. |
I'm familiar with using reticulate but haven't poked under the hood except when debugging. Do you have an idea of what examples you would want or would figuring that out also be part of the example documentation task? |
@missaugustina An example to start with would be using it together with keras R package and tfdatasets package. Examples for different types of datasets would be useful too. |
We need to scaffold R package documentation website. pkgdown is a popular choice in R community to generate this automatically through simple configuration. We should at least scaffold the following pages:
The text was updated successfully, but these errors were encountered: