Skip to content

Commit 2663a11

Browse files
committed
Docs: updated installation instructions, avoid using -U when installing on Kaggle
[skip ci]
1 parent b96aeac commit 2663a11

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Look at a short demo of the NLP Profiler library at one of these:
8989

9090
### Installation
9191

92-
For Conda/Miniconda environments:
92+
**For Conda/Miniconda environments:**
9393

9494
```bash
9595
conda config --set pip_interop_enabled True
@@ -99,19 +99,29 @@ python -m spacy download en_core_web_sm
9999
### now perform any of the below pathways/options
100100
```
101101

102-
From PyPi:
102+
**For Kaggle environments:**
103+
104+
```
105+
pip uninstall typing # this can cause issues on Kaggle hence removing it helps
106+
```
107+
108+
_Follow any of the remaining installation steps but "avoid" using `-U` with `pip install` -- again this can cause issues on Kaggle hence not using it helps_.
109+
110+
**From PyPi:**
103111

104112
```bash
105113
pip install -U nlp_profiler
106114
```
107115

108-
From the GitHub repo:
116+
**From the GitHub repo:**
109117

110118
```bash
111119
pip install -U git+https://github.com/neomatrix369/nlp_profiler.git@master
112120
```
113121

114-
From the source (only for development purposes), see [Developer guide](#developer-guide)
122+
**From the source:**
123+
124+
For library development purposes, see [Developer guide](#developer-guide)
115125

116126
### Usage
117127

0 commit comments

Comments
 (0)