Feature: added multiprocessing for creating hf embedddings #15260
+139
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
the
size:M
…feat/multiprocessing_hfembedddings
nerdai
approved these changes
Aug 10, 2024
There was a problem hiding this comment.
Thanks @shail2512-lm10 for the contribution. Left a minor comment in my review.
Comment on lines
35
to
43
| """ | ||
| Args: | ||
| parallel_process (bool): Default to False. If True it will start a multi-process pool to process the encoding | ||
| with several independent processes. | ||
| target_devices (List[str], optional): It will only taken into account if `parallel_process` = `True`. PyTorch | ||
| target devices, e.g. ["cuda:0", "cuda:1", ...], ["npu:0", "npu:1", ...], or ["cpu", "cpu", "cpu", "cpu"]. | ||
| If target_devices is None and CUDA/NPU is available, then all available CUDA/NPU devices will be used. | ||
| If target_devices is None and CUDA/NPU is not available, then 4 CPU devices will be used. |
There was a problem hiding this comment.
thanks for the class docstring. We should probably expand this to all fields and methods?
|
@shail2512-lm10: We should also bump the version number in this package's |
|
Thank you @nerdai. Sure, will do all the modifications!! |
…feat/multiprocessing_hfembedddings
dosubot
bot
added
size:L
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
It would be great if
HuggingFaceEmbeddingclass had a multiprocessing feature for creating embeddings for vast amounts of text just likeSentenceTransformershas. Hence I added a multiprocessing support for the same.HuggingFaceEmbeddingclass takes additional two arguments: parallel_process and traget_devices. If parallel_process is True then the multiprocess_pool will start as per the methods available inSentenceTransformersand when that task is done the mutliprocess_pool will stop.Reference: SentenceTransformer implementation
PS: This is my first PR in LLamaIndex :)
New Package?
Did I fill in the
tool.llamahubsection in thepyproject.tomland provide a detailed README.md for my new integration or package?Version Bump?
Did I bump the version in the
pyproject.tomlfile of the package I am updating? (Except for thellama-index-corepackage)Type of Change
Please delete options that are not relevant.
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
Suggested Checklist:
make format; make lintto appease the lint gods