Refactor embedding operations and improve configuration#6
Draft
patricktrainer wants to merge 1 commit into
Draft
Refactor embedding operations and improve configuration#6patricktrainer wants to merge 1 commit into
patricktrainer wants to merge 1 commit into
Conversation
Fixes #2 Refactor code to use `EmbeddingKey` class for embedding operations. * **Introduce `EmbeddingKey` class:** - Add `EmbeddingKey` class to encapsulate `text` and `model` in `src/operations.py`. - Update functions in `src/operations.py` to use `EmbeddingKey` instead of tuples for keys. - Refactor `write_embedding_to_table`, `is_key_in_table`, `list_keys_in_table`, and `get_embedding_from_table` to use `EmbeddingKey`. * **Refactor embedding operations:** - Create `EmbeddingOperations` class in `src/embedding_operations.py` to encapsulate embedding-related operations. - Move functions `pickle_embeddings`, `duckdb_embeddings`, and `get_similarity` into `EmbeddingOperations` class. - Add methods for loading and saving embeddings, checking if an embedding exists, and calculating similarity. * **Update embedding functions:** - Refactor `pickle_embeddings` and `duckdb_embeddings` functions in `src/embedding.py` to use `EmbeddingKey`. * **Add error handling:** - Handle potential exceptions when creating embeddings and provide meaningful error messages in `src/openai_client.py`. - Add error handling for database operations to manage connection issues or query failures in `src/connection.py`. * **Add configuration file:** - Add `config.yaml` with database name, model name, paths to files, OpenAI API key, and number of top documents. * **Add tests:** - Create unit tests for `EmbeddingOperations` class in `tests/test_embedding_operations.py`. - Write tests for loading and saving embeddings, checking if an embedding exists, and calculating similarity. - Write tests to verify that the application correctly reads and applies settings from the `config.yaml` file in `tests/test_config.py`.
This file contains hidden or 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
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.
Fixes #2
Refactor code to use
EmbeddingKeyclass for embedding operations.Introduce
EmbeddingKeyclass:EmbeddingKeyclass to encapsulatetextandmodelinsrc/operations.py.src/operations.pyto useEmbeddingKeyinstead of tuples for keys.write_embedding_to_table,is_key_in_table,list_keys_in_table, andget_embedding_from_tableto useEmbeddingKey.Refactor embedding operations:
EmbeddingOperationsclass insrc/embedding_operations.pyto encapsulate embedding-related operations.pickle_embeddings,duckdb_embeddings, andget_similarityintoEmbeddingOperationsclass.Update embedding functions:
pickle_embeddingsandduckdb_embeddingsfunctions insrc/embedding.pyto useEmbeddingKey.Add error handling:
src/openai_client.py.src/connection.py.Add configuration file:
config.yamlwith database name, model name, paths to files, OpenAI API key, and number of top documents.Add tests:
EmbeddingOperationsclass intests/test_embedding_operations.py.config.yamlfile intests/test_config.py.