feat: Add FileExtensionClassifier to previews #5514
Merged
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
vblagoje
requested review from
dfokina and
ZanSara
and removed request for
a team
|
@ZanSara I don't know if |
Pull Request Test Coverage Report for Build 5867619952
💛 - Coveralls |
dfokina
approved these changes
Aug 7, 2023
|
Moved to classifiers as we agreed @ZanSara , please have a look. |
ZanSara
suggested changes
Aug 8, 2023
ZanSara
reviewed
Aug 9, 2023
|
@ZanSara adjusted to use mime types throughout. Tests were adjusted as well. Note that since mime types have "/" and "-" in their name, we need to convert any non-alpha character to "_" to follow dataclass naming convention. Please see comments and adjusted tests for details. |
ZanSara
reviewed
Aug 14, 2023
ZanSara
reviewed
Aug 15, 2023
|
@ZanSara can you please give it another look through |
vblagoje
changed the title
DosticJelena
pushed a commit
to smartcat-labs/haystack
that referenced
this pull request
Aug 23, 2023
* Add FileExtensionClassifier preview component * Add release note * PR feedback
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.
What?
This PR introduces a new component,
FileExtensionClassifier, to our preview. This component classifies files based on their file extensions. It takes a list of file paths as input and groups them by their file extensions. The list of extensions to consider is provided during the initialization of the component.Why?
When working with a large number of files, it can be useful to categorize them based on their mime types. This component simplifies this task by automatically grouping files by their extensions.
How can it be used?
The
FileExtensionClassifiercan be used as a standalone component or as part of a pipeline. Here's a simple example of how to use it:In this example,
classified_fileswill be a dictionary where the keys are the file mime types ("text/plain", "application/pdf", "application/msword"), and the values are lists ofpathlib.Pathobjects, representing the file paths that match the corresponding extension.How did you test it?
Tests for the
FileExtensionClassifierare included in this PR. They verify that the component correctly classifies files based on their extensions and handles various edge cases, such as files without extensions or with unrecognized extensions.Notes for the reviewer
Please pay special attention to the handling of edge cases and the format of the output data. We decided to use
pathlib.Pathobjects in the output to make it easier to work with the file paths in subsequent steps of a pipeline. If you have any suggestions for improvements or see any potential issues, please let me know.