Skip to content

PatchWork GenerateREADME #663

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.

Sign up for GitHub

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

Closed
patched-admin wants to merge 1 commit into from
Closed

PatchWork GenerateREADME #663

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions patchwork/steps/FilterBySimilarity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Documentation for Patchwork FilterBySimilarity Module

## Inputs
- `list`: A list of dictionaries.
- `keywords`: An annotated string indicating keywords for similarity comparison.
- `keys`: An annotated string for configuration.
- `top_k`: An annotated integer for configuration.

## Outputs
- `result_list`: A list of dictionaries sorted by similarity scores.

### `typed.py`
- Defines input and output data types for FilterBySimilarity step in Patchwork.
- Contains TypedDict subclasses for input and output data structures.

### `FilterBySimilarity.py`
- Implements the FilterBySimilarity step in Patchwork.
- Utilizes TF-IDF vectorizer and cosine similarity for similarity calculation.
- Skips the step if the input list is empty.
- Parses keys for text extraction if provided.
- Sorts and returns items from the input list based on similarity scores.

### `__init__.py`
- Placeholder file with no code.