flashrag-dev 0.1.4.dev20250403__tar.gz → 0.1.4.dev20250410__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/PKG-INFO +4 -1
  2. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/README.md +3 -0
  3. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/reranker.py +1 -1
  4. flashrag_dev-0.1.4.dev20250410/flashrag/version.py +1 -0
  5. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag_dev.egg-info/PKG-INFO +4 -1
  6. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag_dev.egg-info/requires.txt +3 -3
  7. flashrag_dev-0.1.4.dev20250403/flashrag/version.py +0 -1
  8. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/LICENSE +0 -0
  9. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/__init__.py +0 -0
  10. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/config/__init__.py +0 -0
  11. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/config/basic_config.yaml +0 -0
  12. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/config/config.py +0 -0
  13. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/dataset/__init__.py +0 -0
  14. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/dataset/dataset.py +0 -0
  15. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/dataset/utils.py +0 -0
  16. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/evaluator/__init__.py +0 -0
  17. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/evaluator/_bleu.py +0 -0
  18. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/evaluator/evaluator.py +0 -0
  19. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/evaluator/metrics.py +0 -0
  20. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/evaluator/utils.py +0 -0
  21. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/__init__.py +0 -0
  22. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/fid.py +0 -0
  23. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/generator.py +0 -0
  24. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/multimodal_generator.py +0 -0
  25. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/openai_generator.py +0 -0
  26. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/stop_word_criteria.py +0 -0
  27. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/generator/utils.py +0 -0
  28. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/judger/__init__.py +0 -0
  29. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/judger/judger.py +0 -0
  30. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/__init__.py +0 -0
  31. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/active_pipeline.py +0 -0
  32. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/branching_pipeline.py +0 -0
  33. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/mm_pipeline.py +0 -0
  34. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/pipeline.py +0 -0
  35. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/reasoning_pipeline.py +0 -0
  36. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/pipeline/replug_utils.py +0 -0
  37. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/prompt/__init__.py +0 -0
  38. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/prompt/base_prompt.py +0 -0
  39. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/prompt/mm_prompt.py +0 -0
  40. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/prompt/selfask_examplars.py +0 -0
  41. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/prompt/trace_examplars.py +0 -0
  42. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/refiner/__init__.py +0 -0
  43. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/refiner/kg_refiner.py +0 -0
  44. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/refiner/llmlingua_compressor.py +0 -0
  45. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/refiner/refiner.py +0 -0
  46. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/refiner/selective_context_compressor.py +0 -0
  47. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/__init__.py +0 -0
  48. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/__main__.py +0 -0
  49. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/encoder.py +0 -0
  50. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/index_builder.py +0 -0
  51. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/retriever.py +0 -0
  52. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/retriever/utils.py +0 -0
  53. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/utils/__init__.py +0 -0
  54. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/utils/constants.py +0 -0
  55. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/utils/pred_parse.py +0 -0
  56. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag/utils/utils.py +0 -0
  57. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag_dev.egg-info/SOURCES.txt +0 -0
  58. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag_dev.egg-info/dependency_links.txt +0 -0
  59. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/flashrag_dev.egg-info/top_level.txt +0 -0
  60. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/pyproject.toml +0 -0
  61. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/setup.cfg +0 -0
  62. {flashrag_dev-0.1.4.dev20250403 → flashrag_dev-0.1.4.dev20250410}/setup.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: flashrag_dev
3
- Version: 0.1.4.dev20250403
3
+ Version: 0.1.4.dev20250410
4
4
  Summary: A library for efficient Retrieval-Augmented Generation research
5
5
  Home-page: https://github.com/RUC-NLPIR/FlashRAG
6
6
  Author: Jiajie Jin, Yutao Zhu, Chenghao Zhang, Xinyu Yang, Zhicheng Dou
@@ -94,6 +94,7 @@ FlashRAG is still under development and there are many issues and room for impro
94
94
  - [ ] Inlcude more RAG approaches
95
95
  - [ ] Add more evaluation metrics (e.g., Unieval, name-entity F1) and benchmarks (e.g., RGB benchmark)
96
96
  - [ ] Enhance code adaptability and readability
97
+ - [ ] Add support for api-based retriever (vllm server)
97
98
 
98
99
  ## :page_with_curl: Changelog
99
100
  [25/03/21] We have added support for **Reasoning Pipeline**, which is a new paradigm that combines reasoning ability and retrieval, representing work that includes [Search-o1](https://github.com/sunnynexus/Search-o1), [R1-Searcher](https://github.com/SsmallSong/R1-Searcher), [ReSearch](https://github.com/Agent-RL/ReSearch). We evaluate the performance of the pipeline on various RAG benchmarks, it can achieve F1 scores close to 60 on multi hop inference datasets such as Hotpotqe. See it in [**result table**](#robot-supporting-methods).
@@ -108,6 +109,8 @@ FlashRAG is still under development and there are many issues and room for impro
108
109
 
109
110
  [25/01/07] We have currently support the aggregation of multiple retrievers, see it in [**multi retriever usage**](https://github.com/RUC-NLPIR/FlashRAG/blob/main/docs/original_docs/multi_retriever_usage.md).
110
111
 
112
+ [25/01/07] We have integrated a very flexible and lightweight corpus chunking library [**Chunkie**](https://github.com/chonkie-ai/chonkie?tab=readme-ov-file#usage), which supports various custom chunking methods (tokens, sentences, semantic, etc.). Use it in [<u>chunking doc corpus</u>](docs/original_docs/chunk-doc-corpus.md).
113
+
111
114
  [24/10/21] We have released a version based on the Paddle framework that supports Chinese hardware platforms. Please refer to [FlashRAG Paddle](https://github.com/RUC-NLPIR/FlashRAG-Paddle) for details.
112
115
 
113
116
  [24/10/13] A new in-domain dataset and corpus - [DomainRAG](https://arxiv.org/pdf/2406.05654) have been added to the dataset. The dataset is based on the internal enrollment data of Renmin University of China, covering seven types of tasks, which can be used for conducting domain-specific RAG testing.
@@ -77,6 +77,7 @@ FlashRAG is still under development and there are many issues and room for impro
77
77
  - [ ] Inlcude more RAG approaches
78
78
  - [ ] Add more evaluation metrics (e.g., Unieval, name-entity F1) and benchmarks (e.g., RGB benchmark)
79
79
  - [ ] Enhance code adaptability and readability
80
+ - [ ] Add support for api-based retriever (vllm server)
80
81
 
81
82
  ## :page_with_curl: Changelog
82
83
  [25/03/21] We have added support for **Reasoning Pipeline**, which is a new paradigm that combines reasoning ability and retrieval, representing work that includes [Search-o1](https://github.com/sunnynexus/Search-o1), [R1-Searcher](https://github.com/SsmallSong/R1-Searcher), [ReSearch](https://github.com/Agent-RL/ReSearch). We evaluate the performance of the pipeline on various RAG benchmarks, it can achieve F1 scores close to 60 on multi hop inference datasets such as Hotpotqe. See it in [**result table**](#robot-supporting-methods).
@@ -91,6 +92,8 @@ FlashRAG is still under development and there are many issues and room for impro
91
92
 
92
93
  [25/01/07] We have currently support the aggregation of multiple retrievers, see it in [**multi retriever usage**](https://github.com/RUC-NLPIR/FlashRAG/blob/main/docs/original_docs/multi_retriever_usage.md).
93
94
 
95
+ [25/01/07] We have integrated a very flexible and lightweight corpus chunking library [**Chunkie**](https://github.com/chonkie-ai/chonkie?tab=readme-ov-file#usage), which supports various custom chunking methods (tokens, sentences, semantic, etc.). Use it in [<u>chunking doc corpus</u>](docs/original_docs/chunk-doc-corpus.md).
96
+
94
97
  [24/10/21] We have released a version based on the Paddle framework that supports Chinese hardware platforms. Please refer to [FlashRAG Paddle](https://github.com/RUC-NLPIR/FlashRAG-Paddle) for details.
95
98
 
96
99
  [24/10/13] A new in-domain dataset and corpus - [DomainRAG](https://arxiv.org/pdf/2406.05654) have been added to the dataset. The dataset is based on the internal enrollment data of Renmin University of China, covering seven types of tasks, which can be used for conducting domain-specific RAG testing.
@@ -44,7 +44,7 @@ class BaseReranker:
44
44
  doc_list = [doc_list]
45
45
 
46
46
  assert len(query_list) == len(doc_list)
47
- if topk < min([len(docs) for docs in doc_list]):
47
+ if topk > min([len(docs) for docs in doc_list]):
48
48
  warnings.warn("The number of doc returned by the retriever is less than the topk.")
49
49
 
50
50
  # get doc contents
@@ -0,0 +1 @@
1
+ __version__ = "0.1.4dev20250410"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: flashrag-dev
3
- Version: 0.1.4.dev20250403
3
+ Version: 0.1.4.dev20250410
4
4
  Summary: A library for efficient Retrieval-Augmented Generation research
5
5
  Home-page: https://github.com/RUC-NLPIR/FlashRAG
6
6
  Author: Jiajie Jin, Yutao Zhu, Chenghao Zhang, Xinyu Yang, Zhicheng Dou
@@ -94,6 +94,7 @@ FlashRAG is still under development and there are many issues and room for impro
94
94
  - [ ] Inlcude more RAG approaches
95
95
  - [ ] Add more evaluation metrics (e.g., Unieval, name-entity F1) and benchmarks (e.g., RGB benchmark)
96
96
  - [ ] Enhance code adaptability and readability
97
+ - [ ] Add support for api-based retriever (vllm server)
97
98
 
98
99
  ## :page_with_curl: Changelog
99
100
  [25/03/21] We have added support for **Reasoning Pipeline**, which is a new paradigm that combines reasoning ability and retrieval, representing work that includes [Search-o1](https://github.com/sunnynexus/Search-o1), [R1-Searcher](https://github.com/SsmallSong/R1-Searcher), [ReSearch](https://github.com/Agent-RL/ReSearch). We evaluate the performance of the pipeline on various RAG benchmarks, it can achieve F1 scores close to 60 on multi hop inference datasets such as Hotpotqe. See it in [**result table**](#robot-supporting-methods).
@@ -108,6 +109,8 @@ FlashRAG is still under development and there are many issues and room for impro
108
109
 
109
110
  [25/01/07] We have currently support the aggregation of multiple retrievers, see it in [**multi retriever usage**](https://github.com/RUC-NLPIR/FlashRAG/blob/main/docs/original_docs/multi_retriever_usage.md).
110
111
 
112
+ [25/01/07] We have integrated a very flexible and lightweight corpus chunking library [**Chunkie**](https://github.com/chonkie-ai/chonkie?tab=readme-ov-file#usage), which supports various custom chunking methods (tokens, sentences, semantic, etc.). Use it in [<u>chunking doc corpus</u>](docs/original_docs/chunk-doc-corpus.md).
113
+
111
114
  [24/10/21] We have released a version based on the Paddle framework that supports Chinese hardware platforms. Please refer to [FlashRAG Paddle](https://github.com/RUC-NLPIR/FlashRAG-Paddle) for details.
112
115
 
113
116
  [24/10/13] A new in-domain dataset and corpus - [DomainRAG](https://arxiv.org/pdf/2406.05654) have been added to the dataset. The dataset is based on the internal enrollment data of Renmin University of China, covering seven types of tasks, which can be used for conducting domain-specific RAG testing.
@@ -16,7 +16,7 @@ transformers>=4.40.0
16
16
  bm25s[core]==0.2.0
17
17
  fschat
18
18
  streamlit
19
- chonkie>=0.4.0
19
+ chonkie<1.1.0,>=1.0.2
20
20
  gradio>=5.0.0
21
21
  rouge-chinese
22
22
  jieba
@@ -40,7 +40,7 @@ transformers>=4.40.0
40
40
  bm25s[core]==0.2.0
41
41
  fschat
42
42
  streamlit
43
- chonkie>=0.4.0
43
+ chonkie<1.1.0,>=1.0.2
44
44
  gradio>=5.0.0
45
45
  rouge-chinese
46
46
  jieba
@@ -64,7 +64,7 @@ transformers>=4.40.0
64
64
  bm25s[core]==0.2.0
65
65
  fschat
66
66
  streamlit
67
- chonkie>=0.4.0
67
+ chonkie<1.1.0,>=1.0.2
68
68
  gradio>=5.0.0
69
69
  rouge-chinese
70
70
  jieba
@@ -1 +0,0 @@
1
- __version__ = "0.1.4dev20250403"