Skip to content

Commit 137e5c7

Browse files
committed
Update installation instructions
1 parent 5c82706 commit 137e5c7

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ This package contains a [PyTorch](https://pytorch.org) implementation of the dee
1212

1313
## Installation
1414

15-
```
15+
```{python}
1616
pip install deep-tensor-py
1717
```
1818

19+
The package can then be imported using
20+
21+
```{python}
22+
import deep_tensor as dt
23+
```
24+
1925
## Examples and Documentation
2026

2127
Examples and documentation are available on the package [website](https://deeptransport.github.io/deep-tensor-py/).
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"hash": "ff3ef0595f928199074d755fced6bbf1",
3+
"result": {
4+
"engine": "jupyter",
5+
"markdown": "---\nformat: html\nbibliography: \"references.bib\"\nexecute: \n eval: false\n---\n\n\n\n\nThe $\\texttt{deep\\_tensor}$ package contains a [PyTorch](https://pytorch.org) implementation of the deep inverse Rosenblatt transport (DIRT) algorithm introduced by @Cui2022.\n\n# Installation\n\n$\\texttt{deep\\_tensor}$ can be installed using pip:\n\n::: {#bdfbd8cd .cell execution_count=1}\n``` {.python .cell-code}\npip install deep-tensor-py\n```\n:::\n\n\nThe package can then be imported using\n\n::: {#b76c168f .cell execution_count=2}\n``` {.python .cell-code}\nimport deep_tensor as dt\n```\n:::\n\n\n# Getting Started\n\nCheck out the [examples page](/examples/index.qmd) and [API reference](/reference/index.qmd) for help getting started with $\\texttt{deep\\_tensor}$.\n\n",
6+
"supporting": [
7+
"index_files"
8+
],
9+
"filters": [],
10+
"includes": {}
11+
}
12+
}

0 commit comments

Comments
 (0)