Commit Graph

49 Commits

Author SHA1 Message Date
Julian Risch 1aa0ad9b8c ci: run type checking on Python 3.12 and unpin numpy (#12377)
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-18 11:03:46 +02:00
Stefano Fiorucci 3795647356 chore: improve CONTRIBUTING.md - pre-commit section (#11094) 2026-04-13 17:11:01 +02:00
Sonja Heinze c8d36442b7 docs: Add pip install pre-commit instructions (#11091)
* Add `install pre-commit` instructions

* Edit: Install Instructions for new Contributors

Changes after feedback from PR
- Clarification for hatch virtual env setup
- Unifying Installation Instructions across all Docs by pointing to CONTRIBUTING.md
2026-04-13 16:26:56 +02:00
Bilge Yücel 1abd5c3fca chore: Update contributing guidelines (#10770)
* chore: Update contributing guidelines

* Add a TLDR for first PR
* Fix the broken link
* Some grammer fixes
* Add high quality contributions section
* Add info about using AI assistants
* Add info about issues to be handled internally

* Update CONTRIBUTING.md

Co-authored-by: bogdankostic <bogdankostic@web.de>

* Update CONTRIBUTING.md

Co-authored-by: bogdankostic <bogdankostic@web.de>

* Update CONTRIBUTING.md

Co-authored-by: bogdankostic <bogdankostic@web.de>

* Add CLA item and address PR comments

* Update CONTRIBUTING.md

Co-authored-by: bogdankostic <bogdankostic@web.de>

* Update CONTRIBUTING.md

Co-authored-by: bogdankostic <bogdankostic@web.de>

---------

Co-authored-by: bogdankostic <bogdankostic@web.de>
2026-03-17 16:44:28 +01:00
Stefano Fiorucci 819ed7244b chore: drop pylint (#10640)
* draft

* progress

* more fixes

* improvs

* strict

* rm pylint

* rm pylint comments

* fix and simplify

* standardize

* more

* alpha order

* final touch

* remove template

* rm ellipsis comments
2026-02-24 07:46:20 +00:00
Guna Palanivel 9952940ba7 chore!: drop Python 3.9 support due to EOL (#10244)
* feat!: drop Python 3.9 support due to EOL

Remove Python 3.9 support following its end-of-life in October 2025.
Minimum required version is now Python 3.10.

BREAKING CHANGE: Python 3.10 or later is now required

Changes:
- Update pyproject.toml requires-python to >=3.10
- Remove Python 3.9 from pyproject.toml classifiers
- Update CI workflows to test Python 3.10 as minimum
- Update mypy python_version to 3.10
- Migrate TypeAlias from typing_extensions to typing stdlib
- Remove blis version pin (only needed for Python 3.9)
- Update CONTRIBUTING.md Python version requirements
- Add release note documenting breaking change

Closes #9854

* small fixes

* update relnote

---------

Co-authored-by: anakin87 <stefanofiorucci@gmail.com>
2025-12-16 19:00:00 +01:00
Stefano Fiorucci af75774c3f chore: rename docs directory and other adjustments (#10157)
* chore: rename docs directory and other adjustments

* fixes
2025-11-28 08:41:35 +01:00
Daria Fokina 5f9982d9a4 docs: documentation readme and contribution guide update (#10023)
* draft readme and contrib-guide upd

* info on versioning

* python scripts remove explainer

* additional updates

* vale instructions upd

* table of contents

* language

* cleanup redundancies

* Update package.json

* section on llms.txt support

* improvements from pr review
2025-11-19 12:38:56 +01:00
Stefano Fiorucci 6cbd1857d1 chore: add info on reStructuredText to contributing guidelines for release notes (#10064)
* chore: add info on reStructuredText to contributing guidelines for release notes

* refine
2025-11-12 13:13:38 +01:00
Stefano Fiorucci 12665ade14 chore: simplify Haystack Hatch scripts (#9491)
* try unifying hatch scripts

* formatting

* simplify

* improve contributing guidelines

* fmt-check
2025-06-06 10:43:02 +02:00
Stefano Fiorucci c3bce46663 docs: update Contribution guidelines with a section about Slow/Unstable tests (#9300)
* docs: update Contribution guidelines with a section about Slow/Unstable tests

* Apply suggestions from code review

Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>

---------

Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
2025-04-24 12:23:43 +02:00
Stefano Fiorucci 10f11d40d4 build: support python 3.13 (#8965)
* support python 3.13

* release note

* add python version info to contributing guide

* better explanation
2025-03-05 09:49:10 +00:00
Stefano Fiorucci ff584f1577 Update CONTRIBUTING.md (#8466) 2024-10-18 15:21:55 +02:00
David S. Batista c4be8370c6 doc: adding some more hatch info to CONTRIBUTING.md (#8201)
* adding some more hatch info to CONTRIBUTING.md

* nit
2024-08-13 15:36:41 +02:00
David S. Batista a67872e7a8 docs: correcting CONTRIBUTING hatch commands (#7963)
* fixing CONTRIBUTING hatch commands

* updating CONTRIBUTING.MD

* Update CONTRIBUTING.md

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

---------

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
2024-07-03 10:59:21 +02:00
Massimiliano Pippi 324bbc3868 chore: clean up default env and add a script to generate release notes. (#7858)
* clean up default env and add reno script

* update contributions guidelines

* use test script

* format

* re-add missing dep

* remove black in favour of ruff
2024-06-14 14:57:24 +02:00
Massimiliano Pippi 19a41a669e docs: update contributor guidelines (#7854)
* update contributor guidelines

* remove occurences of core-integrations

* punctuation

* Apply suggestions from code review

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>

* link the contributions wanted repo

---------

Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
2024-06-14 08:45:32 +02:00
Stefano Fiorucci 43d4730b6c remove reference to the UI directory (#5522) 2023-08-07 11:52:37 +02:00
Massimiliano Pippi 363f3edbf7 feat: add reno to manage release notes (#5397)
* first draft

* add release notes

* remove old settings

* add reno usage instructions

* page the docs team when release notes are added

* add reno to the dev dependencies

* Apply suggestions from code review

Co-authored-by: Stefano Fiorucci <44616784+anakin87@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>

---------

Co-authored-by: Stefano Fiorucci <44616784+anakin87@users.noreply.github.com>
Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
2023-07-24 17:02:46 +02:00
Massimiliano Pippi 8228081e7a chore: leftovers from removing knowledge graph support (#4974)
* leftovers from removing knowledge graph support

* more leftovers
2023-05-22 10:03:51 +02:00
Massimiliano Pippi 4974bf7ab3 chore: remove deprecated MilvusDocumentStore (#4951)
* remove deprecated MilvusDocumentStore

* remove leftovers

* fix pylint
2023-05-19 16:37:38 +02:00
Massimiliano Pippi d322beed6c build: do not install 'dev' extras with 'all' (#4888)
* do not install 'dev' with 'all'

* some fixes around
2023-05-11 19:24:47 +02:00
Tuana Celik 0771cf1cce Update CONTRIBUTING.md (#3624) 2022-11-24 13:59:49 +00:00
Massimiliano Pippi e2110644c4 docs: add tests types to CONTRIBUTING.md (#3158)
* Update CONTRIBUTING.md

Add the outcome of #2811 to the developers docs

Ideally, newly added tests will follow those requirements while we progressively adapt the existing tests to the new model.

* address review comments
2022-09-05 16:56:48 +02:00
Daniel Bichuetti e1f399284f refactor: update dependencies and remove pins (#3147)
* refactor: remove azure-core, pydoc and hf-hub pins

* fix: remove extra-comma

* fix: force minimum version of azure forms recognizer

* refactor: allow newer ocr libs

* refactor: update more dependencies and container versions

* refactor: remove extra comment

* docs: pre-commit manual run

* refactor: remove unnecessary dependency

* tests: update weaviate container image version
2022-09-05 14:30:35 +02:00
Sara Zan e92ea4fccb refactor: rename master into main in documentation and links (#3063)
* master->main

* revert master rename

* Revert change to sphinx link and rename master schema
2022-08-24 19:05:12 +02:00
Ofek Lev f6a4a14790 refactor: update package metadata (#3079)
* Update package metadata

* fix yaml

* remove Python version cap

* address review
2022-08-24 09:46:21 +02:00
Tuana Celik 2298155a20 changing Slack to Discord (#3040)
* changing Slack to Discord

* Update README.md

* updating contributing
2022-08-15 15:56:16 +03:00
James Briggs 4ba2444652 Update CONTRIBUTING.md (#2975) 2022-08-05 19:00:18 +02:00
Tobias Wochinger 065173fe5e chore: add PR template (#2883)
* chore: add PR template

* ci: update PR template after latest discussions in Notion

* Apply suggestions from code review

Co-authored-by: Sara Zan <sara.zanzottera@deepset.ai>

* Apply suggestions from code review

Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>

* Update .github/pull_request_template.md

Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>

* docs: re-order and add link

* docs: add new conventions to contributor guidelines

Co-authored-by: Sara Zan <sara.zanzottera@deepset.ai>
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
2022-08-05 18:14:18 +02:00
Vladimir Blagojevic 515a85d633 Update contributing guide, clarify when '.[all]' install is needed (#2961) 2022-08-04 12:20:07 +02:00
Steven Haley ae84c5a533 Fix typos in Contributing.md (#2897) 2022-07-28 09:30:25 +02:00
Sara Zan b2bd99d799 Recommend installing pre-commit hook on commit (#2890)
* recomment installing hook on commit

* remove change in weaviate docker command
2022-07-27 18:37:35 +02:00
Zoltan Fedor adb2b2c312 Add support for BM25 with the Weaviate document store (#2860)
* Upgrading Weaviate used for testing to 1.14.1 from 1.11.0

This has also brought up an issue with one of the test filtering for value "a". This test has started to fail, as "a" is a default stopword in Weaviate, so I have changed this test to look for value "c" instead of value "a" to get around the stopword issue.

* Weaviate client upgrade

From v3.3.3 to v3.6.0

* Adding BM25 Retrieval to Weaviate

Weaviate now supports BM25 retrieval in experiment mode and with some limitations (like it cannot be combined with filters).
This commit adds support for inverted index (BM25) querying against Weaviate.

* Running Black on the recent code changes

* Update Documentation & Code Style

* Fixing linting issues after code changes by black

* The BM25 query needs to be in all lowercase for now

The BM25 query needs to be provided all lowercase while the functionality is in experimental mode in Weaviate.
See https://app.slack.com/client/T0181DYT9KN/C017EG2SL3H/thread/C017EG2SL3H-1658790227.208119

* Fixing method parameter docstring to highlight that they are not supported in Weaviate

* Update Documentation & Code Style

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-07-27 10:07:13 +02:00
Sara Zan 2d65c380f1 pre-commit hooks (#2819)
* Add pre-commit config

* update contributing guidelines

* try failing the workflow

* add pre-commit to the deps

* updating uninstall instructions

* separate jobs in CI

* make tutorials check fail

* make black check fail

* make openapi check fail

* make yaml schema and api docs checks fail

* highlight the instructions

* Update .pre-commit-config.yaml

Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>

* Update CONTRIBUTING.md

Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>

* Update CONTRIBUTING.md

Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>

* Use black --check

* Add images of the CI

* title level

* feedback

Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>
2022-07-26 15:02:15 +02:00
tstadel 2a7c0139f5 double max heap size for elasticsearch in CI (#2756) 2022-07-05 13:53:32 +02:00
Massimiliano Pippi 7595bb49ab rearrange contributing guidelines (#2515)
* rearrange contributing guidelines

* revert unneeded change to README
2022-05-10 14:59:46 +02:00
Branden Chan 75dcfd3fab Delete files in docs/_src (#2322)
* Delete files in _src

* Filter unused images and re-add images that were in use in docs/img

* Remove all usages of user-images.githubusercontent.com

Co-authored-by: ZanSara <sarazanzo94@gmail.com>
2022-04-12 16:19:03 +02:00
Sara Zan ae712fe6bf Upgrade weaviate-client to 3.3.3 and fix get_all_documents (#1895)
* Fix 'bug' on Weaviate only returning max. 100 docs on get_all_documents

* Add type

* Update Weaviate version on the CI

* Fix bug on get_document_count where there are no documents

* Add more info in the docstrings of get_all_documents and get_all_documents_generator

* Add latest docstring and tutorial changes

* Apply Black

* Update Documentation & Code Style

* Trigger pipeline

* Update Documentation & Code Style

* Include StefanBogdan feedback

* Fix mypy issues and LogicalFilterClause

* Add more types

* Update Documentation & Code Style

* update setup.cfg

* Upgrade weaviate containers too

* Allow to filter for content field in Weaviate

* Use convert_to_weaviate instead of convert_to_pinecone

* Fix _get_all_documents_in_index

* Update docstrings and docs

* Catching an exception in get_document(s)_by_id

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: bogdankostic <bogdankostic@web.de>
2022-04-01 15:37:34 +03:00
Sara Zan 57bb8c4131 Update launch script for Milvus from 1.x to 2.x (#2378) 2022-03-31 12:03:18 +02:00
Bálint Hegyi 3ef672eaef Testing actions (@ZanSara) (#2200)
* Trigger Black (@ZanSara on external account)

* Trigger Black again

* Update Documentation & Code Style

* Add image of how it looks from the contributor's side

* Add screenshot of the check to enable maintainer's access to the fork

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: ZanSara <sarazanzo94@gmail.com>
2022-02-17 12:07:56 +01:00
Sara Zan abc1057869 Disable autoformat.yml on master (#2198)
* disable autoformat.yml on master

* Add a note in CONTRIBUTING.md about branch name
2022-02-16 16:58:12 +01:00
Sara Zan 4e940be859 Allow Linux CI to push changes to forks (#2182)
* Add explicit reference to repo name to allow CI to push code back

* Run test matrix only on tested code changes

* Isolate the bot to check if it works

* Clarify situation with a comment

* Simplify autoformat.yml

* Add code and docs check

* Add git pull to make sure to fetch changes if they were created

* Add cache to autoformat.yml too

* Add information on forks in CONTRIBUTING.md

* Add a not about code quality tools in CONTRIBUTING.md

* Add image file types to the CI exclusion list

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-02-16 16:28:55 +01:00
Markus Paff 04f3b39ad5 Text for contributor license agreement (#1766)
* text for contributor license agreement

* formatting

* Add details about process

* test
2021-12-28 14:01:20 +01:00
Julian Risch 892ce4a760 Make weaviate more compliant to other doc stores (UUIDs and dummy embedddings) (#1656)
* create uuid and dummy embeddding in weaviate doc store

* handle and test for duplicate non-uuid-formatted ids in weaviate

* add uuid and dummy embedding to doc strings

* Add latest docstring and tutorial changes

* Upgrade weaviate

* Include weaviate in common doc store test cases

* Add latest docstring and tutorial changes

* Exclude weaviate doc store from eval tests

* Incorporate index name in uuid generation

* Ignore mypy error

* Fix typo

* Restore DOCS without uuid and embeddings generated by weaviate

* Supply docs for retriever tests as fixture

* Limit scope of fixture to function instead of session

* Add comments

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2021-11-04 09:27:12 +01:00
Malte Pietsch 3a4b3cd59d Update CONTRIBUTING.md 2021-10-18 09:14:03 +02:00
Malte Pietsch 39d324ed17 Fix typo 2021-09-28 16:39:58 +02:00
Malte Pietsch 183fd5ae5a Simplify tests & allow running on individual doc stores (#1487)
* simplify tests for individual doc stores

* WIP refactoring markers of tests

* test alternative approach for tests with existing parametrization

* fix skip logic of already parametrized tests

* fix weaviate behaviour in tests - not parametrizing it in our general test cases.

* Add latest docstring and tutorial changes

* fix some tests

* remove sql from document_store_types

* fix markers for generator and pipeline test

* remove inmemory marker

* remove unneeded elasticsearch markers

* update readme and contributing.md

* update contributing

* adjust example

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2021-09-27 10:52:07 +02:00
Malte Pietsch 686e55b77c Create CONTRIBUTING.md 2020-08-28 13:20:19 +02:00