Skip to content

Commit 1a0c616

Browse files
committed
docs: add notebook aimed to analyze clusters in documentation
1 parent 5caf7c7 commit 1a0c616

16 files changed

+39625
-0
lines changed

docs/notebooks/README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# How using Jupyter Notebooks ?
2+
3+
<details>
4+
<summary>Read the Project Jupyter Documentation</summary>
5+
If needed, see <a href="https://docs.jupyter.org/en/latest/" alt="Project Jupyter Documentation.">https://docs.jupyter.org/en/latest/</a>.
6+
</details>
7+
8+
## 1. Prepare your environment
9+
10+
In your Python environment, install the following libraries (with `pip` or `pipx`):
11+
12+
```
13+
# Needed to launch Jupyter App.
14+
jupyter
15+
jupyterthemes # optional
16+
17+
# Needed to run Jupyter Notebooks.
18+
plotly>=2.5
19+
pandas
20+
numpy
21+
```
22+
23+
## 2. Set token api if needed
24+
25+
To be able to call a model from OpenAI, you need to register and create a token api key on [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys), then store it in a file named `credentials.py` near the notebook.
26+
27+
The content of this file should look like :
28+
29+
```python
30+
OPENAI_API_TOKEN: str = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
31+
32+
# 1. Rename this file in `credentials.py`
33+
# 2. Change value of `OPENAI_API_TOKEN` with your own API token from OpenAI (https://platform.openai.com/account/api-keys).
34+
```
35+
36+
NB: A template file named `credentials.example.py` is available here: [credentials.example.py](./credentials.example.py).
37+
38+
## 3. Get project data
39+
40+
In the web application, after several iterations of annotation, download the zip archive of your project and extract it near the jupyter notebook.
41+
42+
## 4. Lauch Jupyter
43+
44+
Run the following command:
45+
46+
```bash
47+
jupyter notebook
48+
```

0 commit comments

Comments
 (0)