Skip to content

make args its own object #2

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

Open
patricktrainer opened this issue May 29, 2024 · 0 comments · May be fixed by #6
Open

make args its own object #2

patricktrainer opened this issue May 29, 2024 · 0 comments · May be fixed by #6

Comments

@patricktrainer
Copy link
Owner

here we call as individual args

def function(text, model):
    ... 

def get_embedding_from_table(con: DuckDBPyConnection, text: str, model: str) -> List[float]:

and elsewhere we call as one

key = tuple(text, model)
def function(key)
    ...

def is_key_in_table(con: DuckDBPyConnection, key: Tuple[str, str]) -> bool:

the "key" is used as the primary key for the embeddings table. It should probably be immutable.

"SELECT embedding FROM embeddings WHERE text=? AND model=?", [text, model]

patricktrainer added a commit that referenced this issue Oct 30, 2024
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`.
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 a pull request may close this issue.

1 participant