AnswerDotAI / AnswerDotAI/nbdev

`show_doc` rendering issues with TorchScript functions

Open
#1,180 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
Jupyter Notebook
Stars
5.3k
Forks
513
Avg merge
2d 30m
Merged PRs (30d)
8

Description

`show_doc` currently has rendering issues with TorchScript functions.

```python
import torch
from nbdev.showdoc import *

@torch.jit.script
def test(p:torch.Tensor):
"Test torchscript function"
return p

show_doc(test)
```
results in the following output, without a source link in the documentation
```
## ScriptFunction object at 0x7fc550c680e0>
Test torchscript function
```
switching to `show_doc(test.name)`, where `name` is a torchscript function property, displays the method name and github source code link, but not the docstring:
```
## test
test
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.