AutoRAG 0.2.7__tar.gz → 0.2.9__tar.gz

{autorag-0.2.7 → autorag-0.2.9}/AutoRAG.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AutoRAG
-Version: 0.2.7
+Version: 0.2.9
 Summary: Automatically Evaluate RAG pipelines with your own data. Find optimal structure for new RAG product.
 Author-email: Marker-Inc <vkehfdl1@gmail.com>
 License:                                  Apache License
@@ -505,11 +505,11 @@ autorag run_web --trial_path your/path/to/trial_path
 
 <img width="1491" alt="web_interface" src="https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/f6b00353-f6bb-4d8f-8740-1c264c0acbb8">
 
-# Star History
+# ⭐ Star History ⭐
 
 [![Star History Chart](https://api.star-history.com/svg?repos=Marker-Inc-Korea/AutoRAG&type=Date)](https://star-history.com/#Marker-Inc-Korea/AutoRAG&Date)
 
-# Contributors ⭐
+# ✨ Contributors ✨
 
 Thanks go to these wonderful people:
 

{autorag-0.2.7 → autorag-0.2.9}/AutoRAG.egg-info/SOURCES.txt

@@ -104,6 +104,7 @@ autorag/nodes/promptmaker/base.py
 autorag/nodes/promptmaker/fstring.py
 autorag/nodes/promptmaker/long_context_reorder.py
 autorag/nodes/promptmaker/run.py
+autorag/nodes/promptmaker/window_replacement.py
 autorag/nodes/queryexpansion/__init__.py
 autorag/nodes/queryexpansion/base.py
 autorag/nodes/queryexpansion/hyde.py
@@ -227,6 +228,7 @@ docs/source/nodes/passage_reranker/upr.md
 docs/source/nodes/prompt_maker/fstring.md
 docs/source/nodes/prompt_maker/long_context_reorder.md
 docs/source/nodes/prompt_maker/prompt_maker.md
+docs/source/nodes/prompt_maker/window_replacement.md
 docs/source/nodes/query_expansion/hyde.md
 docs/source/nodes/query_expansion/multi_query_expansion.md
 docs/source/nodes/query_expansion/query_decompose.md
@@ -250,6 +252,7 @@ sample_config/config_korean.yaml
 sample_config/extracted_sample.yaml
 sample_config/full.yaml
 sample_config/simple_local.yaml
+sample_config/simple_ollama.yaml
 sample_config/simple_openai.yaml
 sample_dataset/README.md
 sample_dataset/eli5/load_eli5_dataset.py
@@ -323,6 +326,7 @@ tests/autorag/nodes/promptmaker/test_fstring.py
 tests/autorag/nodes/promptmaker/test_long_context_reorder.py
 tests/autorag/nodes/promptmaker/test_prompt_maker_base.py
 tests/autorag/nodes/promptmaker/test_prompt_maker_run.py
+tests/autorag/nodes/promptmaker/test_window_replacement.py
 tests/autorag/nodes/queryexpansion/test_hyde.py
 tests/autorag/nodes/queryexpansion/test_multi_query_expansion.py
 tests/autorag/nodes/queryexpansion/test_pass_query_expansion.py

{autorag-0.2.7 → autorag-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AutoRAG
-Version: 0.2.7
+Version: 0.2.9
 Summary: Automatically Evaluate RAG pipelines with your own data. Find optimal structure for new RAG product.
 Author-email: Marker-Inc <vkehfdl1@gmail.com>
 License:                                  Apache License
@@ -505,11 +505,11 @@ autorag run_web --trial_path your/path/to/trial_path
 
 <img width="1491" alt="web_interface" src="https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/f6b00353-f6bb-4d8f-8740-1c264c0acbb8">
 
-# Star History
+# ⭐ Star History ⭐
 
 [![Star History Chart](https://api.star-history.com/svg?repos=Marker-Inc-Korea/AutoRAG&type=Date)](https://star-history.com/#Marker-Inc-Korea/AutoRAG&Date)
 
-# Contributors ⭐
+# ✨ Contributors ✨
 
 Thanks go to these wonderful people:
 

{autorag-0.2.7 → autorag-0.2.9}/README.md

@@ -234,11 +234,11 @@ autorag run_web --trial_path your/path/to/trial_path
 
 <img width="1491" alt="web_interface" src="https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/f6b00353-f6bb-4d8f-8740-1c264c0acbb8">
 
-# Star History
+# ⭐ Star History ⭐
 
 [![Star History Chart](https://api.star-history.com/svg?repos=Marker-Inc-Korea/AutoRAG&type=Date)](https://star-history.com/#Marker-Inc-Korea/AutoRAG&Date)
 
-# Contributors ⭐
+# ✨ Contributors ✨
 
 Thanks go to these wonderful people:
 

autorag-0.2.9/autorag/VERSION

@@ -0,0 +1 @@
+0.2.9

{autorag-0.2.7 → autorag-0.2.9}/autorag/data/qacreation/base.py

@@ -3,6 +3,7 @@ import uuid
 from typing import Callable, Optional
 
 import pandas as pd
+from tqdm import tqdm
 
 from autorag.utils.util import save_parquet_safe
 
@@ -15,6 +16,7 @@ def make_single_content_qa(corpus_df: pd.DataFrame,
                            output_filepath: Optional[str] = None,
                            upsert: bool = False,
                            random_state: int = 42,
+                           cache_batch: int = 32,
                            **kwargs) -> pd.DataFrame:
     """
     Make single content (single-hop, single-document) QA dataset using given qa_creation_func.
@@ -32,6 +34,9 @@ def make_single_content_qa(corpus_df: pd.DataFrame,
     :param upsert: If true, the function will overwrite the existing file if it exists.
         Default is False.
     :param random_state: The random state for sampling corpus from the given corpus_df.
+    :param cache_batch: The number of batches to use for caching the generated QA dataset.
+        When the cache_batch size data is generated, the dataset will save to the designated output_filepath.
+        If the cache_batch size is too small, the process time will be longer.
     :param kwargs: The keyword arguments for qa_creation_func.
     :return: QA dataset dataframe.
         You can save this as parquet file to use at AutoRAG.
@@ -44,24 +49,31 @@ def make_single_content_qa(corpus_df: pd.DataFrame,
     sampled_corpus = corpus_df.sample(n=content_size, random_state=random_state)
     sampled_corpus = sampled_corpus.reset_index(drop=True)
 
-    qa = qa_creation_func(contents=sampled_corpus['contents'].tolist(), **kwargs)
-    qa_data = pd.DataFrame({
-        'qid': [str(uuid.uuid4()) for _ in range(len(qa))],
-        'qa': qa,
-        'retrieval_gt': sampled_corpus['doc_id'].tolist(),
-    })
-    qa_data = qa_data.explode('qa', ignore_index=True)
-
     def make_query_generation_gt(row):
         return row['qa']['query'], row['qa']['generation_gt']
 
-    qa_data[['query', 'generation_gt']] = qa_data.apply(make_query_generation_gt, axis=1, result_type='expand')
-    qa_data = qa_data.drop(columns=['qa'])
+    qa_data = pd.DataFrame()
+    for idx, i in tqdm(enumerate(range(0, len(sampled_corpus), cache_batch))):
+        qa = qa_creation_func(contents=sampled_corpus['contents'].tolist()[i:i + cache_batch], **kwargs)
+
+        temp_qa_data = pd.DataFrame({
+            'qa': qa,
+            'retrieval_gt': sampled_corpus['doc_id'].tolist()[i:i + cache_batch],
+        })
+        temp_qa_data = temp_qa_data.explode('qa', ignore_index=True)
+        temp_qa_data['qid'] = [str(uuid.uuid4()) for _ in range(len(temp_qa_data))]
+        temp_qa_data[['query', 'generation_gt']] = temp_qa_data.apply(make_query_generation_gt, axis=1,
+                                                                      result_type='expand')
+        temp_qa_data = temp_qa_data.drop(columns=['qa'])
 
-    qa_data['retrieval_gt'] = qa_data['retrieval_gt'].apply(lambda x: [[x]])
-    qa_data['generation_gt'] = qa_data['generation_gt'].apply(lambda x: [x])
+        temp_qa_data['retrieval_gt'] = temp_qa_data['retrieval_gt'].apply(lambda x: [[x]])
+        temp_qa_data['generation_gt'] = temp_qa_data['generation_gt'].apply(lambda x: [x])
 
-    if output_filepath is not None:
-        save_parquet_safe(qa_data, output_filepath, upsert=upsert)
+        if idx == 0:
+            qa_data = temp_qa_data
+        else:
+            qa_data = pd.concat([qa_data, temp_qa_data], ignore_index=True)
+        if output_filepath is not None:
+            save_parquet_safe(qa_data, output_filepath, upsert=upsert)
 
     return qa_data

{autorag-0.2.7 → autorag-0.2.9}/autorag/evaluation/metric/generation.py

@@ -6,7 +6,7 @@ from typing import List, Optional
 
 import evaluate
 import pandas as pd
-import sacrebleu
+from sacrebleu.metrics.bleu import BLEU
 import torch
 from llama_index.core.embeddings import BaseEmbedding
 from llama_index.embeddings.openai import OpenAIEmbedding
@@ -16,11 +16,12 @@ from rouge_score.rouge_scorer import RougeScorer
 
 from autorag import embedding_models
 from autorag.evaluation.metric.util import calculate_cosine_similarity
-from autorag.utils.util import process_batch, openai_truncate_by_token
+from autorag.utils.util import process_batch, openai_truncate_by_token, convert_inputs_to_list
 
 
 def generation_metric(func):
     @functools.wraps(func)
+    @convert_inputs_to_list
     def wrapper(generation_gt: List[List[str]], generations: List[str], **kwargs) -> List[float]:
         """
         Compute generation metric.
@@ -39,6 +40,7 @@ def generation_metric(func):
     return wrapper
 
 
+@convert_inputs_to_list
 def huggingface_evaluate(instance, key: str,
                          generation_gt: List[List[str]], generations: List[str],
                          **kwargs) -> List[float]:
@@ -62,14 +64,28 @@ def huggingface_evaluate(instance, key: str,
     return result
 
 
-@generation_metric
-def bleu(gt: List[str], pred: str, **kwargs) -> float:
+@convert_inputs_to_list
+def bleu(generation_gt: List[List[str]], generations: [str], tokenize: str|None = None, smooth_method: str = 'exp', smooth_value: Optional[float] = None, max_ngram_order: int = 4, trg_lang: str = '', **kwargs) -> List[float]:
     """
-    Compute bleu score for generation.
+    Computes the BLEU metric given pred and ground-truth.
+
+    :param tokenize: The tokenizer to use. If None, defaults to language-specific tokenizers with '13a' as the fallback default. check #https://github.com/mjpost/sacrebleu/blob/master/sacrebleu/metrics/bleu.py
+    :param smooth_method: The smoothing method to use ('floor', 'add-k', 'exp' or 'none').
+    :param smooth_value: The smoothing value for `floor` and `add-k` methods. `None` falls back to default value.
+    :param max_ngram_order: If given, it overrides the maximum n-gram order (default: 4) when computing precisions.
+    :param trg_lang: An optional language code to raise potential tokenizer warnings.
+    :param generation_gt: A list of ground truth.
+        Must be 2-d list of string.
+        Because it can be a multiple ground truth.
+    :param generations: A list of generations that LLM generated.
     """
-    return sacrebleu.sentence_bleu(pred, gt, **kwargs).score
+    bleu = BLEU(tokenize=tokenize, smooth_method=smooth_method, smooth_value=smooth_value, max_ngram_order=max_ngram_order, trg_lang=trg_lang, **kwargs)
+
+    result = list(map(lambda x: bleu.sentence_score(x[0], x[1]).score, zip(generations, generation_gt)))
+    return result
 
 
+@convert_inputs_to_list
 def meteor(generation_gt: List[List[str]], generations: List[str],
            alpha: float = 0.9,
            beta: float = 3.0,
@@ -97,6 +113,7 @@ def meteor(generation_gt: List[List[str]], generations: List[str],
     return result
 
 
+@convert_inputs_to_list
 def rouge(generation_gt: List[List[str]], generations: List[str],
           rouge_type: Optional[str] = 'rougeL',
           use_stemmer: bool = False,
@@ -141,6 +158,7 @@ def rouge(generation_gt: List[List[str]], generations: List[str],
     return result
 
 
+@convert_inputs_to_list
 def sem_score(generation_gt: List[List[str]], generations: List[str],
               embedding_model: Optional[BaseEmbedding] = None,
               batch: int = 128) -> List[float]:
@@ -194,6 +212,7 @@ def sem_score(generation_gt: List[List[str]], generations: List[str],
     return result
 
 
+@convert_inputs_to_list
 def g_eval(generation_gt: List[List[str]], generations: List[str],
            metrics: Optional[List[str]] = None,
            model: str = 'gpt-4-0125-preview',
@@ -283,6 +302,7 @@ async def async_g_eval(generation_gt: List[str], pred: str,
     return sum(g_eval_scores) / len(g_eval_scores)
 
 
+@convert_inputs_to_list
 def bert_score(generation_gt: List[List[str]], generations: List[str],
                lang: str = 'en',
                batch: int = 128,

{autorag-0.2.7 → autorag-0.2.9}/autorag/evaluation/metric/retrieval.py

@@ -1,11 +1,15 @@
 import functools
 import itertools
-import math
 from typing import List
 
+import math
+
+from autorag.utils.util import convert_inputs_to_list
+
 
 def retrieval_metric(func):
     @functools.wraps(func)
+    @convert_inputs_to_list
     def wrapper(retrieval_gt: List[List[List[str]]], pred_ids: List[List[str]]) -> List[float]:
         results = []
         for gt, pred in zip(retrieval_gt, pred_ids):

{autorag-0.2.7 → autorag-0.2.9}/autorag/evaluation/metric/retrieval_contents.py

@@ -9,11 +9,12 @@ from typing import List
 
 import numpy as np
 
-from autorag.utils.util import normalize_string
+from autorag.utils.util import normalize_string, convert_inputs_to_list
 
 
 def retrieval_contents_metric(func):
     @functools.wraps(func)
+    @convert_inputs_to_list
     def wrapper(gt_contents: List[List[str]], pred_contents: List[List[str]]) -> List[float]:
         results = []
         for gt, pred in zip(gt_contents, pred_contents):

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/passagereranker/flag_embedding.py

@@ -1,4 +1,4 @@
-from typing import List, Tuple
+from typing import List, Tuple, Iterable
 
 import pandas as pd
 import torch
@@ -58,7 +58,7 @@ def flag_embedding_run_model(input_texts, model, batch_size: int):
     for batch_texts in tqdm(batch_input_texts):
         with torch.no_grad():
             pred_scores = model.compute_score(sentence_pairs=batch_texts)
-        if batch_size == 1:
+        if batch_size == 1 or not isinstance(pred_scores, Iterable):
             results.append(pred_scores)
         else:
             results.extend(pred_scores)

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/promptmaker/__init__.py

@@ -1,2 +1,3 @@
 from .fstring import fstring
 from .long_context_reorder import long_context_reorder
+from .window_replacement import window_replacement

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/promptmaker/base.py

@@ -1,11 +1,12 @@
 import functools
 import logging
+import os
 from pathlib import Path
 from typing import List, Union
 
 import pandas as pd
 
-from autorag.utils import result_to_dataframe
+from autorag.utils import result_to_dataframe, fetch_contents
 
 logger = logging.getLogger("AutoRAG")
 
@@ -31,6 +32,14 @@ def prompt_maker_node(func):
             assert "retrieve_scores" in previous_result.columns, "previous_result must have retrieve_scores column."
             retrieve_scores = previous_result["retrieve_scores"].tolist()
             return func(prompt, query, retrieved_contents, retrieve_scores)
+        elif func.__name__ == 'window_replacement':
+            retrieved_ids = previous_result["retrieved_ids"].tolist()
+            # load corpus
+            data_dir = os.path.join(project_dir, "data")
+            corpus_data = pd.read_parquet(os.path.join(data_dir, "corpus.parquet"), engine='pyarrow')
+            # get metadata from corpus
+            retrieved_metadata = fetch_contents(corpus_data, retrieved_ids, column_name='metadata')
+            return func(prompt, query, retrieved_contents, retrieved_metadata)
         else:
             raise NotImplementedError(f"Module {func.__name__} is not implemented or not supported.")
 

autorag-0.2.9/autorag/nodes/promptmaker/window_replacement.py

@@ -0,0 +1,46 @@
+import logging
+from typing import List, Dict
+
+from autorag.nodes.promptmaker.base import prompt_maker_node
+
+logger = logging.getLogger("AutoRAG")
+
+
+@prompt_maker_node
+def window_replacement(prompt: str, queries: List[str],
+                       retrieved_contents: List[List[str]],
+                       retrieved_metadata: List[List[Dict]]) -> List[str]:
+    """
+    Replace retrieved_contents with window to create a Prompt
+    (only available for corpus chunked with Sentence window method)
+    You must type a prompt or prompt list at config yaml file like this:
+
+    .. Code:: yaml
+    nodes:
+    - node_type: prompt_maker
+      modules:
+      - module_type: window_replacement
+        prompt: [Answer this question: {query} \n\n {retrieved_contents},
+        Read the passages carefully and answer this question: {query} \n\n Passages: {retrieved_contents}]
+
+    :param prompt: A prompt string.
+    :param queries: List of query strings.
+    :param retrieved_contents: List of retrieved contents.
+    :param retrieved_metadata: List of retrieved metadata.
+    :return: Prompts that made by window_replacement.
+    """
+
+    def window_replacement_row(_prompt: str, _query: str, _retrieved_contents, _retrieved_metadata: List[Dict]) -> str:
+        window_list = []
+        for content, metadata in zip(_retrieved_contents, _retrieved_metadata):
+            if 'window' in metadata:
+                window_list.append(metadata['window'])
+            else:
+                window_list.append(content)
+                logger.info("Only available for corpus chunked with Sentence window method."
+                            "window_replacement will not proceed.")
+        contents_str = "\n\n".join(window_list)
+        return _prompt.format(query=_query, retrieved_contents=contents_str)
+
+    return list(map(lambda x: window_replacement_row(prompt, x[0], x[1], x[2]),
+                    zip(queries, retrieved_contents, retrieved_metadata)))

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/queryexpansion/base.py

@@ -42,6 +42,9 @@ def query_expansion_node(func):
                                 prompt=prompt,
                                 generator_func=generator_callable,
                                 generator_params=generator_param)
+        # delete empty string in the nested expanded queries list
+        expanded_queries = [list(map(lambda x: x.strip(), sublist)) for sublist in expanded_queries]
+        expanded_queries = [list(filter(lambda x: bool(x), sublist)) for sublist in expanded_queries]
         return expanded_queries
 
     return wrapper

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/queryexpansion/query_decompose.py

@@ -47,7 +47,7 @@ decompose_prompt = """Decompose a question in self-contained sub-questions. Use
 
     Question: {question}
 
-    Decompositions:"
+    Decompositions:
     """
 
 

{autorag-0.2.7 → autorag-0.2.9}/autorag/nodes/queryexpansion/run.py

@@ -68,7 +68,7 @@ def run_query_expansion_node(modules: List[Callable],
     # Run evaluation when there are more than one module.
     if len(modules) > 1:
         # pop general keys from strategies (e.g. metrics, speed_threshold)
-        general_key = ['metrics', 'speed_threshold']
+        general_key = ['metrics', 'speed_threshold', 'strategy']
         general_strategy = dict(filter(lambda x: x[0] in general_key, strategies.items()))
         extra_strategy = dict(filter(lambda x: x[0] not in general_key, strategies.items()))
 
@@ -93,7 +93,8 @@ def run_query_expansion_node(modules: List[Callable],
         # run evaluation
         evaluation_results = list(map(lambda result: evaluate_one_query_expansion_node(
             retrieval_callables, retrieval_params, result['queries'].tolist(), retrieval_gt,
-            general_strategy['metrics'], project_dir, previous_result, strategies.get('strategy', 'mean')), results))
+            general_strategy['metrics'], project_dir, previous_result, general_strategy.get('strategy', 'mean')),
+                                      results))
 
         evaluation_df = pd.DataFrame({
             'filename': filenames,

{autorag-0.2.7 → autorag-0.2.9}/autorag/support.py

@@ -58,6 +58,7 @@ def get_support_modules(module_name: str) -> Callable:
         # prompt_maker
         'fstring': ('autorag.nodes.promptmaker', 'fstring'),
         'long_context_reorder': ('autorag.nodes.promptmaker', 'long_context_reorder'),
+        'window_replacement': ('autorag.nodes.promptmaker', 'window_replacement'),
         # generator
         'llama_index_llm': ('autorag.nodes.generator', 'llama_index_llm'),
         'vllm': ('autorag.nodes.generator', 'vllm'),

{autorag-0.2.7 → autorag-0.2.9}/autorag/utils/util.py

@@ -8,13 +8,16 @@ import logging
 import os
 import re
 import string
-import unicodedata
 from copy import deepcopy
-from typing import List, Callable, Dict, Optional, Any, Collection
+from typing import List, Callable, Dict, Optional, Any, Collection, Iterable
 
+import numpy as np
 import pandas as pd
 import tiktoken
+import unicodedata
 from llama_index.embeddings.openai import OpenAIEmbedding
+from pydantic import BaseModel as BM
+from pydantic.v1 import BaseModel
 
 logger = logging.getLogger("AutoRAG")
 
@@ -454,3 +457,30 @@ def embedding_query_content(queries: List[str], contents_list: List[List[str]],
     content_embeddings_flatten = embedding_model.get_text_embedding_batch(flatten_contents)
     content_embeddings = reconstruct_list(content_embeddings_flatten, content_lengths)
     return query_embeddings, content_embeddings
+
+
+def to_list(item):
+    """Recursively convert collections to Python lists."""
+    if isinstance(item, np.ndarray):
+        # Convert numpy array to list and recursively process each element
+        return [to_list(sub_item) for sub_item in item.tolist()]
+    elif isinstance(item, pd.Series):
+        # Convert pandas Series to list and recursively process each element
+        return [to_list(sub_item) for sub_item in item.tolist()]
+    elif isinstance(item, Iterable) and not isinstance(item, (str, bytes, BaseModel, BM)):
+        # Recursively process each element in other iterables
+        return [to_list(sub_item) for sub_item in item]
+    else:
+        return item
+
+
+def convert_inputs_to_list(func):
+    """Decorator to convert all function inputs to Python lists."""
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        new_args = [to_list(arg) for arg in args]
+        new_kwargs = {k: to_list(v) for k, v in kwargs.items()}
+        return func(*new_args, **new_kwargs)
+
+    return wrapper

{autorag-0.2.7 → autorag-0.2.9}/docs/source/api_spec/autorag.nodes.promptmaker.rst

@@ -36,6 +36,14 @@ autorag.nodes.promptmaker.run module
    :undoc-members:
    :show-inheritance:
 
+autorag.nodes.promptmaker.window\_replacement module
+----------------------------------------------------
+
+.. automodule:: autorag.nodes.promptmaker.window_replacement
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

{autorag-0.2.7 → autorag-0.2.9}/docs/source/data_creation/tutorial.md

@@ -80,7 +80,7 @@ from autorag.data.qacreation import generate_qa_llama_index, make_single_content
 corpus_df = pd.read_parquet('path/to/corpus.parquet')
 llm = OpenAI(model='gpt-3.5-turbo', temperature=1.0)
 qa_df = make_single_content_qa(corpus_df, 50, generate_qa_llama_index, llm=llm, question_num_per_content=1,
-                               output_filepath='path/to/qa.parquet')
+                               output_filepath='path/to/qa.parquet', cache_batch=64)
 ```
 
 `generate_qa_llama_index` is a function designed to generate **questions** and its **generation_gt** per content.
@@ -94,6 +94,15 @@ Which means it uses only one passage per question for answering the question.
 Passage is chunked units from raw data.
 ```
 
+```{admonition} Auto-save feature
+From AutoRAG v0.2.9, the auto-save feature added! 
+Now, you don't have to afraid that something wrong while the data generation.
+The data will save automatically to the input `output_filepath`.
+
+You can set how often you want to save the result to the file. 
+Just adjust `cache_batch` parameter. Default is 32.
+```
+
 ## Use custom prompt
 
 You can use custom prompt to generate qa data.

{autorag-0.2.7 → autorag-0.2.9}/docs/source/local_model.md

@@ -25,10 +25,14 @@ myst:
 
 Most of the modules that using LLM model can take `llm` parameter to specify the LLM model.
 
+- [llama_index_llm](nodes/generator/llama_index_llm.md)
+
+The following modules can use generator module, which including `llama_index_llm`.
+
 - [hyde](nodes/query_expansion/hyde.md)
 - [query_decompose](nodes/query_expansion/query_decompose.md)
+- [multi_query_expansion](nodes/query_expansion/multi_query_expansion.md)
 - [tree_summarize](nodes/passage_compressor/tree_summarize.md)
-- [llama_index_llm](nodes/generator/llama_index_llm.md)
 
 ### Supporting LLM models
 
@@ -114,7 +118,8 @@ To change the embedding model, you can change the `embedding_model` parameter to
 |               [cointegrated/rubert-tiny2](https://huggingface.co/cointegrated/rubert-tiny2)               | huggingface_cointegrated_rubert_tiny2 |
 | [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) |     huggingface_all_mpnet_base_v2     |
 
-For example, if you want to use OpenAI curie embedding model, you can set `embedding_model` parameter to `openai_curie`.
+For example, if you want to use OpenAI text embedding large model, you can set `embedding_model` parameter
+to `openai_embed_3_large`.
 
 ```yaml
 nodes:
@@ -126,11 +131,6 @@ nodes:
             embedding_model: openai
 ```
 
-```{attention}
-You can't pass embedding model parameters at the config yaml file like LLM models.
-Because the embedding model is initialized at the beginning of the AutoRAG program.
-```
-
 ### Add your embedding models
 
 You can add more embedding models for AutoRAG.
@@ -141,13 +141,19 @@ execute the following code.
 
 ```python
 import autorag
+from autorag import LazyInit
 from llama_index.embeddings.huggingface import HuggingFaceEmbedding
 
-autorag.generator_models['kosimcse'] = HuggingFaceEmbedding("BM-K/KoSimCSE-roberta-multitask")
+autorag.embedding_models['kosimcse'] = LazyInit(HuggingFaceEmbedding, model_name="BM-K/KoSimCSE-roberta-multitask")
 ```
 
 Then you can use `kosimcse` at config yaml file.
 
 ```{caution}
-When you add new LLM model, you should add instance of the `BaseEmbedding` class from LlamaIndex.
+When you add new embedding model, you should use `LazyInit` class from autorag. The additional parameters have to be keyword parameter in the `LazyInit` initialization. 
 ```
+
+## Use vllm
+
+You can use vllm to use local LLM. For more information, please check out [vllm](nodes/generator/vllm.md) generator
+module docs.

{autorag-0.2.7 → autorag-0.2.9}/docs/source/nodes/passage_reranker/koreranker.md

@@ -12,7 +12,11 @@ More details can be found [here](https://huggingface.co/Dongjin-kr/ko-reranker).
 
 
 ## **Module Parameters**
-- **Not Applicable (N/A):** There are no direct module parameters specified for the `ko-reranker` module.
+
+(Optional) `batch`
+
+- Specify batch size of the query to the Ko-reranker model.
+- default is 64.
 
 ## **Example config.yaml**
 ```yaml

{autorag-0.2.7 → autorag-0.2.9}/docs/source/nodes/passage_reranker/monot5.md

@@ -17,6 +17,10 @@ given query.
       allowing for flexible integration of different monoT5 variants.
     - default is `castorini/monot5-3b-msmarco-10k`
 
+- (Optional) `batch`
+    - Specify batch size of the query to the TART model.
+    - default is 64.
+
 ## **Example config.yaml**
 
 ```yaml

{autorag-0.2.7 → autorag-0.2.9}/docs/source/nodes/passage_reranker/tart.md

@@ -14,6 +14,11 @@ The `TART` module is a reranker based on [TART](https://arxiv.org/pdf/2211.09260
 - Specifies instructions for the reranking process. 
 - default is `Find passage to answer given question`
 
+(Optional) `batch`
+
+- Specify batch size of the query to the TART model.
+- default is 64.
+
 ## **Example config.yaml**
 ```yaml
 modules:

{autorag-0.2.7 → autorag-0.2.9}/docs/source/nodes/prompt_maker/prompt_maker.md

@@ -68,4 +68,5 @@ maxdepth: 1
 ---
 fstring.md
 long_context_reorder.md
+window_replacement.md
 ```