Skip to content

Commit

Permalink
chore: disclaimer on autofaiss (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
frederik-encord authored Apr 24, 2024
1 parent bc49bb4 commit 5122e4c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,10 @@ To contribute by adding model sources, follow these steps:
3. Document the addition of the model source, providing details on its structure, usage, and any specific considerations or instructions for integration.
This ensures that users have clear guidance on how to leverage the new model source effectively.

## Known Issues

1. `autofaiss`: The project depends on the [autofaiss][autofaiss] library which can give some trouble on windows. Please reach out or raise an issue with as many system and version details as possible if you encounter it.

[Falah/Alzheimer_MRI]: https://huggingface.co/datasets/Falah/Alzheimer_MRI
[trpakov/chest-xray-classification]: https://huggingface.co/datasets/trpakov/chest-xray-classification
[Kabil007/LungCancer4Types]: https://huggingface.co/datasets/Kabil007/LungCancer4Types
Expand All @@ -399,3 +403,4 @@ To contribute by adding model sources, follow these steps:
[local-model-impl]: https://github.com/encord-team/text-to-image-eval/blob/main/tti_eval/model/types/local_clip_model.py
[hf-dataset-impl]: https://github.com/encord-team/text-to-image-eval/blob/main/tti_eval/dataset/types/hugging_face.py
[encord-dataset-impl]: https://github.com/encord-team/text-to-image-eval/blob/main/tti_eval/dataset/types/encord_ds.py
[autofaiss]: https://pypi.org/project/autofaiss/

0 comments on commit 5122e4c

Please sign in to comment.