Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up[TF 2.0 API Docs] tf.math.acos #25802
Comments
Hi @dynamicwebpaige. I searched through the tensorflow repo, and it looks like one needs to edit the .pbtxt files inside |
@Sudeepam97 The cc: @MarkDaoust @lamberta to keep me honest, though! Do we have a recommended process for updating those docs? |
@Sudeepam97 Just confirmed that you are correct! Apologies for the confusion - the Let me take a look at your PR; we might need to tweak the syntax a little bit (format is a special flavor of markdown). Check out this endpoint for a usage example. |
@dynamicwebpaige, that's great! Please take your time to review the PR, I'll be happy to work on any changes that are necessary. |
@dynamicwebpaige |
I would love contributing to this. Please tell me how to proceed as I am newcomer. |
@SSaishruthi are there any ops left to do |
Just a note for people working on this: if you add python doctests, please make sure to do so in Python files, not in base_api/api_def files as those are the APIs for other languages too. |
System information
Describe the documentation issue
Documentation for
tf.math.acos
is created from a generated file,python/ops/gen_math_ops.py
. It would be excellent to have a link to the files that are used to generategen_math_ops.py
- so a user could make modifications quickly, without having to search throughtensorflow/tensorflow
.tf.math.acos
could use a clear description, usage examples, and example visuals. A great template to model this on could benumpy.arccos
.Users also experience obfuscated errors from unexpected arguments (ex: strings, Booleans, and even just
int
s). Some examples are shared below. The file used to generate this error is located here. Alltf.math.*
operations and the operations they influence (e.g.,tf.linspace
) would experience these same obfuscated XLA errors.We welcome contributions by users. Will you be able to update submit a PR (use the doc style guide) to fix the doc Issue?
I shall certainly try! :)