Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bugfix: added entry for callback to clear _node_data_buffer #8867

Conversation

azurewtl
Copy link
Contributor

@azurewtl azurewtl commented Nov 12, 2023

Description

In OpenInferenceCallbackHandler, both self._query_data_buffer and self._node_data_buffer grows persistently and require manual clearing.
In production env, we need to provide a callback to OpenInferenceCallbackHandler for logging and clearing node_data_buffer, but node_data_buffer is out of access in callback, which leave it grows out of control.

class ParquetCallback:
    ...
    def __call__(
        self,
        query_data_buffer: List[QueryData],
    ) -> None:
        if len(query_data_buffer) > self._max_buffer_length:
            ...
            self._batch_index += 1
            query_data_buffer.clear()  # ⚠️ clear the buffer or it will keep growing forever!

Fixes

pass self._node_data_buffer to callback function, so it can clear it periodically

    def end_trace(...) -> None:
        if trace_id == "query":
            ...
            if self._callback is not None:
                self._callback(self._query_data_buffer, self._node_data_buffer)

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added new unit/integration tests
  • Added new notebook (that tests end-to-end)
  • I stared at the code and made sure it makes sense

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@logan-markewich logan-markewich merged commit 9c45e36 into run-llama:main Nov 14, 2023
@ryanpeach ryanpeach mentioned this pull request Feb 7, 2024
15 tasks
ryanpeach pushed a commit to OnScale/llama_index that referenced this pull request Feb 7, 2024
@ryanpeach ryanpeach mentioned this pull request Feb 7, 2024
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants