Skip to content

Commit f68c8a5

Browse files
authored
Update README.md
1 parent 6524f93 commit f68c8a5

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,16 @@ This toolbox implements the analyses described in the above NeurIPS paper. We es
1616

1717
## Usage
1818

19-
To demonstrate the application of the toolbox, two Jupyter notebooks have been provided in the <a href="https://github.com/naplab/PyTCI/tree/main/Examples">`Examples/`</a> directory:
19+
To demonstrate the application of the toolbox, two Jupyter notebooks have been provided in the "Examples" directory:
2020

21-
1. <a href="https://github.com/naplab/PyTCI/blob/main/Examples/Example-Toy.ipynb"><strong>Basic</strong></a>: Shows how to apply the TCI method to a toy model that integrates sound energy within a gamma-distributed window.
21+
1. <a href="https://nbviewer.org/github/naplab/PyTCI/blob/main/Examples/Example-Toy.ipynb"><strong>Example-Toy</strong></a>: Shows how to apply the TCI method to a toy model that integrates sound energy within a gamma-distributed window. Covers most of the functionality of the toolbox.
2222

23-
2. <a href="https://github.com/naplab/PyTCI/blob/main/Examples/Example-DeepSpeech.ipynb"><strong>Advanced</strong></a>: Shows how to use the TCI method to estimate integration windows from the DeepSpeech2 model described in the paper, implemented in PyTorch. This notebook requires the pretrained model and speech audio clips in `Examples/resources.tar` to be extracted and placed in a directory named `Examples/resources`.
23+
2. <a href="https://nbviewer.org/github/naplab/PyTCI/blob/main/Examples/Example-DeepSpeech.ipynb"><strong>Example-DeepSpeech</strong></a>: Shows how to use the TCI method to estimate integration windows from the DeepSpeech2 model described in the paper, implemented in PyTorch. This notebook requires the pretrained model and speech audio clips in `Examples/resources.tar` to be extracted and placed in a directory named `Examples/resources`. It also has extra dependencies that need to be installed.
2424

25-
<strong>NOTE</strong>: These notebooks might not render as intended on GitHub. For correct rendering, open them locally in a Jupyter notebook.
25+
<strong>NOTE</strong>: These notebooks might not render as intended on GitHub. For correct rendering, open them locally in a Jupyter notebook or using nbviewer.
2626

2727
## Installation
2828

29-
To install this package through pip, run the following command:
29+
To install or update this package through pip, run the following command:
3030

3131
`pip install git+https://github.com/naplab/PyTCI.git`
32-
33-
You can use the same command to update the package.

0 commit comments

Comments
 (0)