Skip to content

Commit a3a1ea4

Browse files
committed
clean up readme
1 parent 7b0de44 commit a3a1ea4

File tree

12 files changed

+34
-34
lines changed

12 files changed

+34
-34
lines changed

examples/amazon_s3_embedding/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ Before running the example, you need to:
3333

3434
Install dependencies:
3535

36-
```sh
36+
```bash
3737
pip install -e .
3838
```
3939

4040
Run:
4141

42-
```sh
42+
```bash
4343
python main.py
4444
```
4545

@@ -52,14 +52,14 @@ CocoInsight is in Early Access now (Free) 😊 You found us! A quick 3 minute vi
5252

5353
Run CocoInsight to understand your RAG data pipeline:
5454

55-
```sh
55+
```bash
5656
cocoindex server -ci main
5757
```
5858

5959
You can also add a `-L` flag to make the server keep updating the index to reflect source changes at the same time:
6060

61-
```sh
62-
cocoindex server -ci -L main
61+
```bash
62+
cocoindex update -L main
6363
```
6464

6565
Then open the CocoInsight UI at [https://cocoindex.io/cocoinsight](https://cocoindex.io/cocoinsight).

examples/azure_blob_embedding/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ Before running the example, you need to:
3333

3434
Install dependencies:
3535

36-
```sh
36+
```bash
3737
pip install -e .
3838
```
3939

4040
Run:
4141

42-
```sh
42+
```bash
4343
python main.py
4444
```
4545

@@ -52,14 +52,14 @@ CocoInsight is in Early Access now (Free) 😊 You found us! A quick 3 minute vi
5252

5353
Run CocoInsight to understand your RAG data pipeline:
5454

55-
```sh
55+
```bash
5656
cocoindex server -ci main
5757
```
5858

5959
You can also add a `-L` flag to make the server keep updating the index to reflect source changes at the same time:
6060

61-
```sh
62-
cocoindex server -ci -L main
61+
```bash
62+
cocoindex server -ci main
6363
```
6464

6565
Then open the CocoInsight UI at [https://cocoindex.io/cocoinsight](https://cocoindex.io/cocoinsight).

examples/custom_output_files/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Each time when you run the `update` command, cocoindex will only re-process the
3838
You can also run `update` command in live mode, which will keep the target in sync with the source in real-time:
3939

4040
```bash
41-
cocoindex update -L main.py
41+
cocoindex update -L main
4242
```
4343

4444
## CocoInsight

examples/custom_source_hn/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ Each time when you run the `update` command, cocoindex will only re-process thre
3737
You can also run `update` command in live mode, which will keep the target in sync with the source continuously:
3838

3939
```bash
40-
cocoindex update -L main.py
40+
cocoindex update -L main
4141
```
4242

4343
## CocoInsight
4444

4545
I used CocoInsight (Free beta now) to troubleshoot the index generation and understand the data lineage of the pipeline.
4646
It just connects to your local CocoIndex server, with Zero pipeline data retention. Run following command to start CocoInsight:
4747

48-
```
49-
cocoindex server -ci -L main
48+
```bash
49+
cocoindex server -ci main
5050
```
5151

5252
Then open the CocoInsight UI at [https://cocoindex.io/cocoinsight](https://cocoindex.io/cocoinsight).

examples/face_recognition/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ cocoindex update main
4444
You can also run the command with `-L`, which will watch for file changes and update the index automatically.
4545

4646
```bash
47-
cocoindex update -L main.py
47+
cocoindex update -L main
4848
```
4949

5050
## CocoInsight

examples/gdrive_text_embedding/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,19 @@ Before running the example, you need to:
4444

4545
- Install dependencies:
4646

47-
```sh
47+
```bash
4848
pip install -e .
4949
```
5050

5151
- Setup:
5252

53-
```sh
53+
```bash
5454
cocoindex setup main
5555
```
5656

5757
- Run:
5858

59-
```sh
59+
```bash
6060
python main.py
6161
```
6262

@@ -68,14 +68,14 @@ At the same time, it accepts queries from the terminal, and performs search on t
6868
I used CocoInsight (Free beta now) to troubleshoot the index generation and understand the data lineage of the pipeline.
6969
It just connects to your local CocoIndex server, with Zero pipeline data retention. Run following command to start CocoInsight:
7070

71-
```sh
71+
```bash
7272
cocoindex server -ci main
7373
```
7474

7575
You can also add a `-L` flag to make the server keep updating the index to reflect source changes at the same time:
7676

77-
```sh
78-
cocoindex server -ci -L main
77+
```bash
78+
cocoindex server -ci main
7979
```
8080

8181
Then open the CocoInsight UI at [https://cocoindex.io/cocoinsight](https://cocoindex.io/cocoinsight).

examples/image_search/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export OLLAMA_MODEL="gemma3" # Optional, for caption generation
6767
```
6868

6969
- Configure model (optional):
70-
```sh
70+
```bash
7171
# All ColVision models supported by colpali-engine are available
7272
# See https://github.com/illuin-tech/colpali#list-of-colvision-models for the complete list
7373

@@ -100,7 +100,7 @@ The current PyTorch install supports CUDA capabilities sm_37 sm_50 sm_60 sm_61 s
100100

101101
You can install the nightly pytorch build here: https://pytorch.org/get-started/locally/
102102

103-
```sh
103+
```bash
104104
pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu129
105105
```
106106

examples/live_updates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ The script then starts a `FlowLiveUpdater`, which runs in the background and con
5454
To remove the database table created by this example, you can run:
5555

5656
```bash
57-
cocoindex drop main.py
57+
cocoindex drop main
5858
```

examples/meeting_notes_graph/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The source is Google Drive folders shared with a service account. The flow watch
4444

4545
Set the following environment variables:
4646

47-
```sh
47+
```bash
4848
export OPENAI_API_KEY=sk-...
4949
export GOOGLE_SERVICE_ACCOUNT_CREDENTIAL=/absolute/path/to/service_account.json
5050
export GOOGLE_DRIVE_ROOT_FOLDER_IDS=folderId1,folderId2

examples/patient_intake_extraction_baml/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ This example shows how to use [BAML](https://boundaryml.com/) to extract structu
1414

1515
2. Install dependencies
1616

17-
```sh
17+
```bash
1818
pip install -U cocoindex baml-py
1919
```
2020

2121
3. **Generate BAML client code** (required step!)
2222

23-
```sh
23+
```bash
2424
baml generate
2525
```
2626

2727
This generates the `baml_client/` directory with Python code to call your BAML functions.
2828

2929
4. Create a `.env` file. You can copy it from `.env.example` first:
3030

31-
```sh
31+
```bash
3232
cp .env.example .env
3333
```
3434

@@ -38,15 +38,15 @@ This example shows how to use [BAML](https://boundaryml.com/) to extract structu
3838

3939
Update index:
4040

41-
```sh
41+
```bash
4242
cocoindex update main
4343
```
4444

4545
## CocoInsight
4646

4747
I used CocoInsight (Free beta now) to troubleshoot the index generation and understand the data lineage of the pipeline. It just connects to your local CocoIndex server, with zero pipeline data retention. Run following command to start CocoInsight:
4848

49-
```sh
49+
```bash
5050
cocoindex server -ci main
5151
```
5252

0 commit comments

Comments
 (0)