Unify vector_dim and embedding_dim parameter in Document Store

[mathew55]

Closes Issue #1740.

The issue is about having consistency in the 'embedding dimension' parameter used across the different document stores.

Milvus1.x, Milvus2.x & Faiss were using vector_dim to capture this while all other document stores were using embedding_dim.

The embedding_dim parameter is introduced to Milvus & Faiss Document Stores. Deprecation warnings will be given to users using vector_dim.

Status (please check what you already did):

• First draft (up for discussions & feedback)
• Final code
• Added tests
• Updated documentation

[bogdankostic]

Hi @mathew55, thank you so much for your very first contribution to Haystack! This looks already really good! There are just two more smaller points that need to be addressed with regard to the naming of embedding_dim parameter:

• In some of the tests, we still use vector_dim. We should switch there to embedding_dim as well.
• In Tutorial 12 we still call FAISSDocumentStore with vector_dim parameter. We should switch there to embedding_dim as well.

Do you want to add these changes to your PR? :)

[mathew55]

@bogdankostic , Thank you for reviewing, I will make the above changes and add it to the PR.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[mathew55]

@bogdankostic , I have updated the changes you have mentioned. Will you be able to check again?

I had trouble running milvus locally, so was not able to run the unit test cases on my local.

[bogdankostic]

This look really good to me, we just need to change this line to use embedding_dim instead of vector_dim.

Then all the tests should pass and we should be able to merge this PR! :)

[mathew55]

@bogdankostic , Can you check now, I have made the change mentioned

[bogdankostic]

FYI, I moved the usage of the vector_dim parameter to the if-block where we print out the deprecation warning to make it easier in the future when we'll remove this parameter.

[bogdankostic]

This looks really good to me! Thank you very much for your first contribution to Haystack 😊

[mathew55]

@bogdankostic , Thank you for the helping me with the reviews! Hoping to contribute more in the future!