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

Error in Operator implementation guide #12168

Closed
apeforest opened this issue Aug 14, 2018 · 6 comments · Fixed by #12482
Closed

Error in Operator implementation guide #12168

apeforest opened this issue Aug 14, 2018 · 6 comments · Fixed by #12482
Labels

Comments

@apeforest
Copy link
Contributor

Description

Error in the operator implementation guide:
https://mxnet.incubator.apache.org/faq/add_op_in_backend.html

It's correct in the markdown file: https://github.com/apache/incubator-mxnet/blob/master/docs/faq/add_op_in_backend.md

Error Message:

"Note that forward and backward functions are registered with attribute key FCompute, rather than FCompute."

@apeforest
Copy link
Contributor Author

apeforest commented Aug 14, 2018

@mxnet-label-bot could you please add [Doc] here?

@apeforest
Copy link
Contributor Author

@nswamy Please label [Doc] for this issue. Thanks

@anirudhacharya
Copy link
Member

@apeforest there is an ongoing PR to update the operator implementation guide - #12230 If you could comment there about what issue you found in the tutorial, it can be fixed in that PR itself.

@apeforest
Copy link
Contributor Author

@anirudhacharya The markdown file in the github is correct. The problem happens in the html generation.

@apeforest
Copy link
Contributor Author

@nswamy This error is not related to Operator. It is purely a html error. Please remove the [Operator] label and changed it to [Doc]. Thanks!

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Sep 5, 2018

I think I found the culprit.
The md-->html build when you do make html or make docs gives you things like <gpu> which renders fine in the browser.

There's a post-process step for building the versioned website that uses beautiful soup to inject the modified nav bar. It also has a step that swaps out the html tags for < and > with actual < and >.
https://github.com/apache/incubator-mxnet/blame/master/docs/build_version_doc/AddVersion.py#L77

So, introduce this AddVersion.py script and it swaps it back to <gpu>. You can see this in the website static files that have gone through this process:
https://github.com/apache/incubator-mxnet-site/blob/asf-site/faq/add_op_in_backend.html#L751
This does not render properly. This is the same thing happening with the scala tutorial: #11438

I can remove that line, but I don't know why it's there in the first place. @piiswrong - you authored it... do you remember what it is for? Can we safely remove it, or provide a more focused implementation so it doesn't break the tags we're trying to put in there?

EDIT: I commented that line out and reran the process on master, and the output is fixed. Not sure if something somewhere is broken though...
http://34.201.8.176/versions/tag_render/faq/add_op_in_backend.html
2018-09-04_17-27-28
It also fixes the tags in scala tutorial:
2018-09-04_17-29-47

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants