Skip to content

Commit daaac3b

Browse files
committed
[skip actions] updated readme and docs
1 parent 9272ae2 commit daaac3b

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ Although the installation includes PyTorch, the best and recommended way is to f
3434
Once, you have got Pytorch installed, just use:
3535

3636
```bash
37-
pip install pytorch_tabular[extra]
37+
pip install -U pytorch_tabular[extra]
3838
```
3939

4040
to install the complete library with extra dependencies (Weights&Biases & Plotly).
4141

4242
And :
4343

4444
```bash
45-
pip install pytorch_tabular
45+
pip install -U pytorch_tabular
4646
```
4747

4848
for the bare essentials.
@@ -58,7 +58,7 @@ git clone git://github.com/manujosephv/pytorch_tabular
5858
Once you have a copy of the source, you can install it with:
5959

6060
```bash
61-
pip install .[extra]
61+
cd pytorch_tabular && pip install .[extra]
6262
```
6363

6464
## Documentation

docs/contributing.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,11 @@ git clone git@github.com:your_name_here/pytorch_tabular.git
5959

6060
* Fork the pytorch_tabular repo on GitHub.
6161

62-
* Clone your fork locally:
62+
* Clone your fork locally and change directory to the checked out folder:
6363

6464
```bash
6565
git clone git@github.com:your_name_here/pytorch_tabular.git
66+
cd pytorch_tabular
6667
```
6768

6869
* Setup a local environment (preferably in a virtual environment).
@@ -106,7 +107,11 @@ git clone git@github.com:your_name_here/pytorch_tabular.git
106107
```bash
107108
pre-commit run --all-files
108109
```
109-
Accept the changes if any after reviewing.
110+
Accept the changes if any after reviewing.
111+
112+
!!!warning
113+
114+
Do not commit pre-commit changes to to `setup.cfg`. The file has been excluded from one hook for bump2version compatibility. For a complet and uptodate list of excluded files, please check `.pre-commit-config.yaml` file.
110115

111116
* Commit your changes and push your branch to GitHub:
112117
```bash

0 commit comments

Comments
 (0)