AnswerDotAI / AnswerDotAI/nbdev
`show_doc` rendering issues with TorchScript functions
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 514
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
`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
```
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem bereitgestellten Python-Reproducer unter Verwendung von nbdev.showdoc.show_doc und einer TorchScript-Funktion. Verfolge, wie show_doc den Funktionsnamen, den Docstring und den GitHub-Quelllink extrahiert; abgeschlossen ist die Aufgabe, wenn TorchScript-Funktionen ihren Namen, Docstring und GitHub-Quelllink korrekt rendern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python, pytorch
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100