Skip to content

Commit

Permalink
[docs] update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@fate-ubw
fate-ubw committed Aug 23, 2024
1 parent 636ae4d commit 4a08f3b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
0 ..._gpu_scheduling_scripts/auto_eval_ALCE.py → ...gpu_scheduling_scripts/auto_eval_ALCE.txt
View file
File renamed without changes.
48 changes: 24 additions & 24 deletions auto_gpu_scheduling_scripts/auto_run-factscore.txt
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
sh run-raglab_result/2-eval_fact-raglab-active_rag-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-active_rag-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-active_rag-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-direct_llm-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-direct_llm-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-direct_llm-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-iter_retgen-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-iter_retgen-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-iter_retgen-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-naive_rag-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-naive_rag-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-naive_rag-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-query_rewrite_rag-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-query_rewrite_rag-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-query_rewrite_rag-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-self_ask-Llama3_70B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-self_ask-Llama3_8B_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-self_ask-gpt3.5_baseline-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_70B-adaptive_retrieval-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_70B-always_retrieval-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_70B-no_retrieval-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_8B-adaptive_retrieval-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_8B-always_retrieval-GPT.sh
sh run-raglab_result/2-eval_fact-raglab-selfrag-selfrag_8B-no_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-active_rag-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-active_rag-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-active_rag-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-direct_llm-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-direct_llm-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-direct_llm-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-iter_retgen-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-iter_retgen-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-iter_retgen-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-naive_rag-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-naive_rag-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-naive_rag-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-query_rewrite_rag-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-query_rewrite_rag-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-query_rewrite_rag-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-self_ask-Llama3_70B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-self_ask-Llama3_8B_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-self_ask-gpt3.5_baseline-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_70B-adaptive_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_70B-always_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_70B-no_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_8B-adaptive_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_8B-always_retrieval-GPT.sh
sh ./run/Factscore/2-eval_fact-raglab-selfrag-selfrag_8B-no_retrieval-GPT.sh
8 changes: 4 additions & 4 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@
## Setup colbert server
- All algorithms integrated in raglab include two modes: `interact` and `evaluation`. The test stage demonstrates in `interact` mode, just for demostration and eduction 🤗.
> [!NOTE]
> - Due to colbert's requirement for absolute paths, you need to modify the index_dbPath and text_dbPath in the config file to use absolute paths.
> [!NOTE]
> - Due to colbert's requirement for absolute paths, you need to modify the index_dbPath and text_dbPath in the config file to use absolute paths.
- Modify the `index_dbPath` and `text_dbPath` in config file:[colbert_server-10samples.yaml](./config/colbert_server/colbert_server-10samples.yaml)
~~~bash
index_dbPath: /your_root_path/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2023-10samples
Expand All @@ -119,8 +119,8 @@
cd RAGLAB
sh run/colbert_server/colbert_server-10samples.sh
~~~
> [!NOTE]
> - At this point, colbert embedding will prompt that due to path errors, colbert embedding needs to be reprocessed. Please enter `yes` and then raglab will automatically help you process the embedding and start the colbert server.
> [!NOTE]
> - At this point, colbert embedding will prompt that due to path errors, colbert embedding needs to be reprocessed. Please enter `yes` and then raglab will automatically help you process the embedding and start the colbert server.
- Now please open another terminal and try to request the colbert server
~~~bash
cd RAGLAB
Expand Down

0 comments on commit 4a08f3b

Please sign in to comment.