Skip to content

Commit faafd4b

Browse files
committed
revert changes
1 parent 128fbdd commit faafd4b

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

docs/pages/usage.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,44 +13,42 @@ It offers functionalities to download datasets, load them into Python environmen
1313

1414
## Installation
1515
`coderdata` requires `python>=3.9` to be installed. The installed version can be checked via
16-
<div class="code-block">
17-
<p>$ python --version</p>
18-
<p>Python 3.13.1</p>
19-
</div>
20-
16+
```shell
17+
$ python --version
18+
Python 3.13.1
19+
```
2120
If a Python version older that 3.9 is installed please referr to the instruction at [python.org](https://www.python.org/about/gettingstarted/#installing) on how to install / update Python.
2221

2322
The preferred way to install `coderdata` is via `pip`. Executing the command below will install the most recent published version of `coderdata` including all required dependencies.
24-
<div class="code-block">
25-
<p>$ pip install coderdata</p>
26-
</div>
23+
```shell
24+
$ pip install coderdata
25+
```
2726

2827
To check if the package has been sucessfully installed open an interactive python termial and import the package. See an example of what to expect below.
29-
<div class="code-block">
30-
<p>\>\>\> import coderdata as cd</p>
31-
<p>\>\>\> cd.__version__</p>
32-
<p>'0.1.40'</p>
33-
</div>
28+
```python
29+
>>> import coderdata as cd
30+
>>> cd.__version__
31+
'0.1.40'
32+
```
3433

3534
## Usage
3635
The primary way to interact with coderdata is through the `coderdata` API. Additionally a command line interface with limited functionality (primarily to download data) is also available.
3736

3837
### CLI
3938
Invoking `coderdata` from the command line will by default print a help / usage message and exit (see below):
40-
<div class="code-block">
41-
<p>$ coderdata</p>
42-
<p>usage: coderdata [-h] [-l | -v] {download} ...</p>
43-
<p></p>
44-
<p>options:</p>
45-
<p> -h, --help show this help message and exit</p>
46-
<p> -l, --list prints list of available datasets and exits program.</p>
47-
<p> -v, --version prints the versions of the coderdata API and dataset and exits the program</p>
48-
<p></p>
49-
<p>commands:</p>
50-
<p> {download}</p>
51-
<p> download subroutine to download datasets. See "coderdata download -h" for more options.</p>
52-
</div>
39+
```sh
40+
$ coderdata
41+
usage: coderdata [-h] [-l | -v] {download} ...
5342

43+
options:
44+
-h, --help show this help message and exit
45+
-l, --list prints list of available datasets and exits program.
46+
-v, --version prints the versions of the coderdata API and dataset and exits the program
47+
48+
commands:
49+
{download}
50+
download subroutine to download datasets. See "coderdata download -h" for more options.
51+
```
5452

5553
The primary use case of the CLI is to retrieve dataset from the repository. This can be done by invoking the `download` routine of `coderdata`. Without defining a specific dataset the whole repository will be downloaded:
5654
```sh
@@ -273,4 +271,4 @@ Note that only individual splits (e.g. only train) can be saved and loaded and n
273271
274272
## Conclusion
275273
CoderData provides a robust and flexible way to work with cancer benchmark data.
276-
By using these functionalities, researchers and data scientists can easily manipulate and analyze complex datasets in their Python environments
274+
By using these functionalities, researchers and data scientists can easily manipulate and analyze complex datasets in their Python environments

0 commit comments

Comments
 (0)