bulk-chain 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

bulk_chain/api.py

@@ -1,41 +1,35 @@
+import asyncio
 import collections
+import logging
 import os
 from itertools import chain
 
 from bulk_chain.core.llm_base import BaseLM
+from bulk_chain.core.service_asyncio import AsyncioService
 from bulk_chain.core.service_batch import BatchIterator
 from bulk_chain.core.service_data import DataService
 from bulk_chain.core.service_dict import DictionaryService
 from bulk_chain.core.service_json import JsonService
 from bulk_chain.core.service_schema import SchemaService
-from bulk_chain.core.utils import dynamic_init, find_by_prefix
+from bulk_chain.core.utils import attempt_wrapper
 
 
 INFER_MODES = {
-    "batch": lambda llm, batch, limit_prompt=None: llm.ask_core(
-        DataService.limit_prompts(batch, limit=limit_prompt))
+    "single": lambda llm, batch, **kwargs: [llm.ask(prompt) for prompt in batch],
+    "single_stream": lambda llm, batch, **kwargs: [llm.ask_stream(prompt) for prompt in batch],
+    "batch": lambda llm, batch, **kwargs: llm.ask(batch),
+    "batch_async": lambda llm, batch, **kwargs: AsyncioService.run_tasks(
+        batch=batch, async_handler=llm.ask_async, event_loop=kwargs.get("event_loop")
+    ),
+    "batch_stream_async": lambda llm, batch, **kwargs: AsyncioService.run_tasks(
+        batch=batch, async_handler=llm.ask_stream_async, event_loop=kwargs.get("event_loop")
+    ),
 }
 
 
 CWD = os.getcwd()
 
 
-def _iter_entry_content(entry, entry_info=None, **kwargs):
-
-    if isinstance(entry, str):
-        kwargs.get("callback_str_func", lambda *_: None)(entry, entry_info)
-        yield entry
-    elif isinstance(entry, collections.abc.Iterable):
-        h = kwargs.get("callback_stream_func", lambda *_: None)
-        h(None, entry_info | {"action": "start"})
-        for chunk in map(lambda item: str(item), entry):
-            yield chunk
-            h(chunk, entry_info)
-        h(None, entry_info | {"action": "end"})
-    else:
-        raise Exception(f"Non supported type `{type(entry)}` for handling output from batch")
-
-
 def _iter_batch_prompts(c, batch_content_it, **kwargs):
     for ind_in_batch, entry in enumerate(batch_content_it):
         content = DataService.get_prompt_text(
@@ -45,15 +39,53 @@ def _iter_batch_prompts(c, batch_content_it, **kwargs):
         yield ind_in_batch, content
 
 
-def _iter_batch_responses(p_column, c, batch_content_it, **kwargs):
+def __handle_agen_to_gen(handle, batch, event_loop):
+    """ This handler provides conversion of the async generator to generator (sync).
+    """
+
+    def __wrap_with_index(async_gens):
+        async def wrapper(index, agen):
+            async for item in agen:
+                yield index, item
+        return [wrapper(i, agen) for i, agen in enumerate(async_gens)]
+
+    agen_list = handle(batch, event_loop=event_loop)
+
+    it = AsyncioService.async_gen_to_iter(
+        gen=AsyncioService.merge_generators(*__wrap_with_index(agen_list)),
+        loop=event_loop)
+
+    for ind_in_batch, chunk in it:
+        yield ind_in_batch, str(chunk)
+
+
+def __handle_gen(handle, batch, event_loop):
+    """ This handler deals with the iteration of each individual element of the batch.
+    """
+
+    def _iter_entry_content(entry):
+        if isinstance(entry, str):
+            yield entry
+        elif isinstance(entry, collections.abc.Iterable):
+            for chunk in map(lambda item: str(item), entry):
+                yield chunk
+        else:
+            raise Exception(f"Non supported type `{type(entry)}` for handling output from batch")
+
+    for ind_in_batch, entry in enumerate(handle(batch, event_loop=event_loop)):
+        for chunk in _iter_entry_content(entry=entry):
+            yield ind_in_batch, chunk
+
+
+def _iter_chunks(p_column, batch_content_it, **kwargs):
+    handler = __handle_agen_to_gen if kwargs["infer_mode"] == "batch_stream_async" else __handle_gen
     p_batch = [item[p_column] for item in batch_content_it]
-    # TODO. This part could be async.
-    # TODO. ind_in_batch might be a part of the async return.
-    for ind_in_batch, entry in enumerate(kwargs["handle_batch_func"](p_batch)):
-        yield ind_in_batch, _iter_entry_content(entry=entry, entry_info={"ind": ind_in_batch, "param": c}, **kwargs)
+    it = handler(handle=kwargs["handle_batch_func"], batch=p_batch, event_loop=kwargs["event_loop"])
+    for ind_in_batch, chunk in it:
+        yield ind_in_batch, chunk
 
 
-def _infer_batch(batch, schema, return_mode, cols=None, **kwargs):
+def _infer_batch(batch, batch_ind, schema, return_mode, cols=None, **kwargs):
     assert (isinstance(batch, list))
 
     if len(batch) == 0:
@@ -73,17 +105,21 @@ def _infer_batch(batch, schema, return_mode, cols=None, **kwargs):
 
         # Handling column for inference.
         if c in schema.r2p:
-            content_it = _iter_batch_responses(c=c, p_column=schema.r2p[c], batch_content_it=iter(batch), **kwargs)
-            for ind_in_batch, chunk_it in content_it:
-
-                chunks = []
-                for chunk in chunk_it:
-                    chunks.append(chunk)
-
-                    if return_mode == "chunk":
-                        yield [ind_in_batch, c, chunk]
-
-                batch[ind_in_batch][c] = "".join(chunks)
+            content_it = _iter_chunks(p_column=schema.r2p[c], batch_content_it=iter(batch), **kwargs)
+            # Register values.
+            for item in batch:
+                item[c] = []
+            for ind_in_batch, chunk in content_it:
+                # Append batch.
+                batch[ind_in_batch][c].append(chunk)
+                # Returning (optional).
+                if return_mode == "chunk":
+                    global_ind = batch_ind * len(batch) + ind_in_batch
+                    yield [global_ind, c, chunk]
+
+            # Convert content to string.
+            for item in batch:
+                item[c] = "".join(item[c])
 
     if return_mode == "record":
         for record in batch:
@@ -93,14 +129,21 @@ def _infer_batch(batch, schema, return_mode, cols=None, **kwargs):
         yield batch
 
 
-def iter_content(input_dicts_it, llm, schema, batch_size=1, limit_prompt=None, return_mode="batch", **kwargs):
+def iter_content(input_dicts_it, llm, schema, batch_size=1, limit_prompt=None,
+                 infer_mode="batch", return_mode="batch", attempts=1, event_loop=None,
+                 **kwargs):
     """ This method represent Python API aimed at application of `llm` towards
         iterator of input_dicts via cache_target that refers to the SQLite using
         the given `schema`
     """
-    assert (return_mode in ["batch", "chunk"])
+    assert (infer_mode in INFER_MODES.keys())
+    assert (return_mode in ["batch", "chunk", "record"])
     assert (isinstance(llm, BaseLM))
 
+    # Setup event loop.
+    event_loop = asyncio.get_event_loop_policy().get_event_loop() \
+        if event_loop is None else event_loop
+
     # Quick initialization of the schema.
     if isinstance(schema, str):
         schema = JsonService.read(schema)
@@ -112,32 +155,32 @@ def iter_content(input_dicts_it, llm, schema, batch_size=1, limit_prompt=None, r
         input_dicts_it
     )
 
+    handle_batch_func = lambda batch, **handle_kwargs: INFER_MODES[infer_mode](
+        llm,
+        DataService.limit_prompts(batch, limit=limit_prompt),
+        **handle_kwargs
+    )
+
+    # Optional wrapping into attempts.
+    if attempts > 1:
+        # Optional setup of the logger.
+        logger = logging.getLogger(__name__)
+        logging.basicConfig(level=logging.INFO)
+
+        attempt_dec = attempt_wrapper(attempts=attempts,
+                                      delay_sec=kwargs.get("attempt_delay_sec", 1),
+                                      logger=logger)
+        handle_batch_func = attempt_dec(handle_batch_func)
+
     content_it = (_infer_batch(batch=batch,
-                               handle_batch_func=lambda batch: INFER_MODES["batch"](llm, batch, limit_prompt),
+                               batch_ind=batch_ind,
+                               infer_mode=infer_mode,
+                               handle_batch_func=handle_batch_func,
+                               handle_missed_value_func=lambda *_: None,
                                return_mode=return_mode,
                                schema=schema,
+                               event_loop=event_loop,
                                **kwargs)
-                  for batch in BatchIterator(prompts_it, batch_size=batch_size))
+                  for batch_ind, batch in enumerate(BatchIterator(prompts_it, batch_size=batch_size)))
 
     yield from chain.from_iterable(content_it)
-
-
-def init_llm(adapter, **model_kwargs):
-    """ This method perform dynamic initialization of LLM from third-party resource.
-    """
-    assert (isinstance(adapter, str))
-
-    # List of the Supported models and their API wrappers.
-    models_preset = {
-        "dynamic": lambda: dynamic_init(class_dir=CWD, class_filepath=llm_model_name,
-                                        class_name=llm_model_params)(**model_kwargs)
-    }
-
-    # Initialize LLM model.
-    params = adapter.split(':')
-    llm_model_type = params[0]
-    llm_model_name = params[1] if len(params) > 1 else params[-1]
-    llm_model_params = ':'.join(params[2:]) if len(params) > 2 else None
-    llm = find_by_prefix(d=models_preset, key=llm_model_type)()
-
-    return llm, llm_model_name

bulk_chain/core/llm_base.py

@@ -1,50 +1,24 @@
-import logging
-import time
-
-
 class BaseLM(object):
 
-    def __init__(self, name=None, attempts=None, delay_sec=1, enable_log=True,
-                 support_batching=False, **kwargs):
-
-        self.__name = name
-        self.__attempts = 1 if attempts is None else attempts
-        self.__delay_sec = delay_sec
-        self.__support_batching = support_batching
-
-        if enable_log:
-            self.__logger = logging.getLogger(__name__)
-            logging.basicConfig(level=logging.INFO)
-
-    def ask_core(self, batch):
-
-        for i in range(self.__attempts):
-            try:
-                if self.__support_batching:
-                    # Launch in batch mode.
-                    content = batch
-                else:
-                    # Launch in non-batch mode.
-                    assert len(batch) == 1, "The LM does not support batching," \
-                                            f" while size of the content is {len(batch)} which is not equal 1. " \
-                                            f"Please enable batch-supporting or set required inference settings."
-                    content = batch[0]
-
-                response = self.ask(content)
+    def __init__(self, **kwargs):
+        pass
 
-                # Wrapping into batch the response in the case of non-batching mode.
-                return response if self.__support_batching else [response]
-
-            except Exception as e:
-                if self.__logger is not None:
-                    self.__logger.info("Unable to infer the result. Try {} out of {}.".format(i, self.__attempts))
-                    self.__logger.info(e)
-                time.sleep(self.__delay_sec)
+    def ask(self, content):
+        """ Assumes to return str.
+        """
+        raise NotImplemented()
 
-        raise Exception("Can't infer")
+    def ask_stream(self, content):
+        """ Assumes to return generator.
+        """
+        raise NotImplemented()
 
-    def ask(self, content):
+    async def ask_async(self, prompt):
+        """ Assumes to return co-routine.
+        """
         raise NotImplemented()
 
-    def name(self):
-        return self.__name.replace("/", "_")
+    async def ask_stream_async(self, batch):
+        """ Assumes to return AsyncGenerator.
+        """
+        raise NotImplemented()

bulk_chain/core/service_asyncio.py

@@ -0,0 +1,65 @@
+import asyncio
+from typing import AsyncGenerator, Any
+
+
+class AsyncioService:
+
+    @staticmethod
+    async def _run_tasks_async(batch, async_handler):
+        tasks = [async_handler(prompt) for prompt in batch]
+        return await asyncio.gather(*tasks)
+
+    @staticmethod
+    async def _run_generator(gen, output_queue, idx):
+        try:
+            async for item in gen:
+                await output_queue.put((idx, item))
+        finally:
+            await output_queue.put((idx, StopAsyncIteration))
+
+
+    @staticmethod
+    def run_tasks(event_loop, **tasks_kwargs):
+        return event_loop.run_until_complete(AsyncioService._run_tasks_async(**tasks_kwargs))
+
+    @staticmethod
+    async def merge_generators(*gens: AsyncGenerator[Any, None]) -> AsyncGenerator[Any, None]:
+
+        output_queue = asyncio.Queue()
+        tasks = [
+            asyncio.create_task(AsyncioService._run_generator(gen, output_queue, idx))
+            for idx, gen in enumerate(gens)
+        ]
+
+        finished = set()
+        while len(finished) < len(tasks):
+            idx, item = await output_queue.get()
+            if item is StopAsyncIteration:
+                finished.add(idx)
+            else:
+                yield item
+
+        for task in tasks:
+            task.cancel()
+
+    @staticmethod
+    def async_gen_to_iter(gen, loop=None):
+        """ This approach is limited. Could be considered as legacy.
+            https://stackoverflow.com/questions/71580727/translating-async-generator-into-sync-one/78573267#78573267
+        """
+
+        loop_created = False
+        if loop is None:
+            loop_created = True
+            loop = asyncio.new_event_loop()
+
+        asyncio.set_event_loop(loop)
+        try:
+            while True:
+                try:
+                    yield loop.run_until_complete(gen.__anext__())
+                except StopAsyncIteration:
+                    break
+        finally:
+            if loop_created:
+                loop.close()

bulk_chain/core/service_batch.py

@@ -1,8 +1,8 @@
 class BatchIterator:
 
     def __init__(self, data_iter, batch_size, end_value=None, filter_func=None):
-        assert(isinstance(batch_size, int) and batch_size > 0)
-        assert(callable(end_value) or end_value is None)
+        assert (isinstance(batch_size, int) and batch_size > 0)
+        assert (callable(end_value) or end_value is None)
         self.__data_iter = data_iter
         self.__index = 0
         self.__batch_size = batch_size

bulk_chain/core/utils.py

@@ -1,6 +1,7 @@
 import importlib
 import logging
 import sys
+import time
 from collections import Counter
 from os.path import dirname, join, basename
 
@@ -60,10 +61,10 @@ def auto_import(name, is_class=False):
     return m() if is_class else m
 
 
-def dynamic_init(class_dir, class_filepath, class_name=None):
+def dynamic_init(class_filepath, class_name=None):
 
     # Registering path.
-    target = join(class_dir, dirname(class_filepath))
+    target = join(dirname(class_filepath))
     logger.info(f"Adding sys path for `{target}`")
     sys.path.insert(1, target)
     class_path_list = class_filepath.split('/')
@@ -89,3 +90,21 @@ def optional_limit_iter(it_data, limit=None):
         if limit is not None and counter["returned"] > limit:
             break
         yield data
+
+
+def attempt_wrapper(attempts, delay_sec=1, logger=None):
+    def decorator(func):
+        def wrapper(*args, **kwargs):
+            for i in range(attempts):
+                try:
+                    # Do action.
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    if logger is not None:
+                        logger.info(f"Unable to infer the result. Try {i} out of {attempts}.")
+                        logger.info(e)
+                    if delay_sec is not None:
+                        time.sleep(delay_sec)
+            raise Exception(f"Failed after {attempts} attempts")
+        return wrapper
+    return decorator

{bulk_chain-1.0.0.dist-info → bulk_chain-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bulk_chain
-Version: 1.0.0
+Version: 1.1.0
 Summary: A lightweight, no-strings-attached Chain-of-Thought framework for your LLM, ensuring reliable results for bulk input requests.
 Home-page: https://github.com/nicolay-r/bulk-chain
 Author: Nicolay Rusnachenko
@@ -15,9 +15,8 @@ Classifier: Topic :: Text Processing :: Linguistic
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: tqdm
 
-# bulk-chain 1.0.0
+# bulk-chain 1.1.0
 ![](https://img.shields.io/badge/Python-3.9-brightgreen.svg)
 [![](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/nicolay-r/bulk-chain/blob/master/bulk_chain_tutorial.ipynb)
 [![twitter](https://img.shields.io/twitter/url/https/shields.io.svg?style=social)](https://x.com/nicolayr_/status/1847969224636961033)
@@ -78,16 +77,36 @@ Below, is an example on how to declare your own schema:
 
 # Usage
 
-Preliminary steps:
+## 🤖 Prepare 
 
-1. Define your [schema](#chain-of-thought-schema) ([Example for Sentiment Analysis](/ext/schema/thor_cot_schema.json)))
-2. Wrap or pick **LLM model** from the [<b>Third-party providers hosting</b>↗️](https://github.com/nicolay-r/nlp-thirdgate?tab=readme-ov-file#llm).
+1. [schema](#chain-of-thought-schema)
+    * [Example for Sentiment Analysis](test/schema/thor_cot_schema.json)
+2. **LLM model** from the [<b>Third-party providers hosting</b>↗️](https://github.com/nicolay-r/nlp-thirdgate?tab=readme-ov-file#llm).
+3. Data (iter of dictionaries)
 
+## 🚀 Launch
 
+> **API**: For more details see the [**related Wiki page**](https://github.com/nicolay-r/bulk-chain/wiki)
 
-## API
-
-Please take a look at the [**related Wiki page**](https://github.com/nicolay-r/bulk-chain/wiki)
+```python
+from bulk_chain.core.utils import dynamic_init
+from bulk_chain.api import iter_content
+
+content_it = iter_content(
+    # 1. Your schema.              
+    schema="YOUR_SCHEMA.json",
+    # 2. Your third-party model implementation.
+    llm=dynamic_init(class_filepath="replicate_104.py", class_name="Replicate")(api_token="<API-KEY>"),
+    # 3. Customize your inference and result providing modes: 
+    infer_mode="batch_async", 
+    return_mode="batch",
+    # 4. Your iterator of dictionaries
+    input_dicts_it=YOUR_DATA_IT,
+)
+    
+for content in content_it:
+    # Handle your LLM responses here ...
+```
 
 
 # Embed your LLM

bulk_chain-1.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+bulk_chain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bulk_chain/api.py,sha256=gPGjaHYIn2Ewn6yXIXER-CM5SgXQ3ZJH-SdRyaPDOo0,6890
+bulk_chain/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bulk_chain/core/llm_base.py,sha256=aa73TGW03yLXMHY4b_1NgquRvP0CzH8IWZkcFPABFUg,557
+bulk_chain/core/service_asyncio.py,sha256=S-D4K3LBa3noKTm0tXazluYVI8cBgN1IB6v6MFoMyNQ,1972
+bulk_chain/core/service_batch.py,sha256=lWmjO0aU6h2rmfx_kGmNqt0Rdeaf2a4Dn5VyfKFkfDs,1033
+bulk_chain/core/service_data.py,sha256=OWWHHnr_plwxYTxLuvMrhEc1PbSx-XC3rbFzV0hy3vk,1107
+bulk_chain/core/service_dict.py,sha256=lAghLU-3V3xYGv5BTA327Qcw8UJYmgQRMFdggzlrUgo,383
+bulk_chain/core/service_json.py,sha256=6o1xM_8c9QEjH9Q3qEmJylU9nahfRXhUd5sFF2dGJwo,182
+bulk_chain/core/service_schema.py,sha256=KIP4n0Tz2h1i7SIMGhgAhoiCgUFXOT1rzMt38yACS2U,1154
+bulk_chain/core/utils.py,sha256=tp1FJQBmJt-3QmG7B0hyJNTFyg_8BwTTdl8xTxSgNDk,3140
+bulk_chain-1.1.0.dist-info/LICENSE,sha256=VF9SjNpwwSSFEY_eP_8A1ocDCrbwfjI1pZexXdCkOwo,1076
+bulk_chain-1.1.0.dist-info/METADATA,sha256=EheCGDisKF0TwmzJfnDxW-rgsDVPNpCYGOvuaDn91tw,4428
+bulk_chain-1.1.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+bulk_chain-1.1.0.dist-info/top_level.txt,sha256=Hxq_wyH-GDXKBaA63UfBIiMJO2eCHJG5EOrXDphpeB4,11
+bulk_chain-1.1.0.dist-info/RECORD,,

{bulk_chain-1.0.0.dist-info → bulk_chain-1.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.3)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

bulk_chain-1.0.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-bulk_chain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bulk_chain/api.py,sha256=d_c10Je8wUSnCdQjyWCHVx4FGW6M2_pBMMqKsI_YJaY,5119
-bulk_chain/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bulk_chain/core/llm_base.py,sha256=DZ9l4HpCs9uKTZp68miw_XCqmRAJBqQPuYSK889CeUk,1785
-bulk_chain/core/service_batch.py,sha256=LMxrZeQXV_AJAoCaMCHVx8TvjcmCaKUQhNE8K4D8pCo,1031
-bulk_chain/core/service_data.py,sha256=OWWHHnr_plwxYTxLuvMrhEc1PbSx-XC3rbFzV0hy3vk,1107
-bulk_chain/core/service_dict.py,sha256=lAghLU-3V3xYGv5BTA327Qcw8UJYmgQRMFdggzlrUgo,383
-bulk_chain/core/service_json.py,sha256=6o1xM_8c9QEjH9Q3qEmJylU9nahfRXhUd5sFF2dGJwo,182
-bulk_chain/core/service_schema.py,sha256=KIP4n0Tz2h1i7SIMGhgAhoiCgUFXOT1rzMt38yACS2U,1154
-bulk_chain/core/utils.py,sha256=Dx9Gy-jPpk-w_8WUekN0Ij4RBIWVAPg74vA3N0JgGqc,2471
-bulk_chain-1.0.0.dist-info/LICENSE,sha256=VF9SjNpwwSSFEY_eP_8A1ocDCrbwfjI1pZexXdCkOwo,1076
-bulk_chain-1.0.0.dist-info/METADATA,sha256=TR86CmhcHJ3Sep8TlHZ0Ede_PnH8G5iMILUvVvSskJY,3810
-bulk_chain-1.0.0.dist-info/WHEEL,sha256=pL8R0wFFS65tNSRnaOVrsw9EOkOqxLrlUPenUYnJKNo,91
-bulk_chain-1.0.0.dist-info/top_level.txt,sha256=Hxq_wyH-GDXKBaA63UfBIiMJO2eCHJG5EOrXDphpeB4,11
-bulk_chain-1.0.0.dist-info/RECORD,,