Initial functional doc - Githubissues

wenleix commented 2 years ago

Also refactored functional._dispatch so we can create stub with docstring.

TODO: This "runtime" module torcharrow._functional.functional doesn't seem to work well when generating docs. We should fix https://github.com/facebookresearch/torcharrow/issues/264 for docs rendering.

WARNING: autodoc: failed to import function 'bucketize' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'firstx' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'sigrid_hash' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'bucketize' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'firstx' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_cosine_similarity' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_jaccard_similarity' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_max_count' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_score_max' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_score_min' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'get_score_sum' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'has_id_overlap' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'id_overlap_count' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'scale_to_0_1' from module 'functional'; the following exception was raised:
No module named 'functional'
WARNING: autodoc: failed to import function 'sigrid_hash' from module 'functional'; the following exception was raised:
No module named 'functional'