faiss/c_api
Ryan Russell d2806286d2 docs: Improve readability (#2378)
Summary:
Signed-off-by: Ryan Russell <git@ryanrussell.org>

Various readability fixes focused on `.md` files:
- Grammar
- Fix some incorrect command references to `distributed_kmeans.py`
- Styling the markdown bash code snippets sections so they format

Attempted to put a lot of little things into one PR and commit; let me know if any mods are needed!

Best,
Ryan

Pull Request resolved: https://github.com/facebookresearch/faiss/pull/2378

Reviewed By: alexanderguzhva

Differential Revision: D37717671

Pulled By: mdouze

fbshipit-source-id: 0039192901d98a083cd992e37f6b692d0572103a
2022-07-08 09:19:07 -07:00
..
gpu Remove redundant c_api headers while installing (#1841) 2021-04-26 02:20:23 -07:00
impl Generalize DistanceComputer for flat indexes (#2255) 2022-03-20 23:43:33 -07:00
utils Add faiss_pairwise_L2sqr_with_defaults into C_API (#2067) 2021-10-07 03:43:57 -07:00
AutoTune_c.cpp Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
AutoTune_c.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
CMakeLists.txt Summary: Add Binary Index i.o to c_api (#2233) 2022-03-16 03:28:46 -07:00
Clustering_c.cpp C_API: Improve PreTransformIndex (#1945) 2021-06-23 07:06:20 -07:00
Clustering_c.h C_API: Improve PreTransformIndex (#1945) 2021-06-23 07:06:20 -07:00
INSTALL.md docs: Improve readability (#2378) 2022-07-08 09:19:07 -07:00
IndexBinary_c.cpp Summary: Add Binary Index i.o to c_api (#2233) 2022-03-16 03:28:46 -07:00
IndexBinary_c.h Summary: Add Binary Index i.o to c_api (#2233) 2022-03-16 03:28:46 -07:00
IndexFlat_c.cpp IndexFlatCodes: a single parent for all flat codecs (#2132) 2021-12-07 01:31:07 -08:00
IndexFlat_c.h C_API: Improve PreTransformIndex (#1945) 2021-06-23 07:06:20 -07:00
IndexIVFFlat_c.cpp Add setters for IndexIVF* indexes (#1827) 2021-04-22 05:22:40 -07:00
IndexIVFFlat_c.h Add setters for IndexIVF* indexes (#1827) 2021-04-22 05:22:40 -07:00
IndexIVF_c.cpp Cover more types for C_API (#1917) 2021-06-08 15:34:05 -07:00
IndexIVF_c.h Cover more types for C_API (#1917) 2021-06-08 15:34:05 -07:00
IndexLSH_c.cpp IndexFlatCodes: a single parent for all flat codecs (#2132) 2021-12-07 01:31:07 -08:00
IndexLSH_c.h IndexFlatCodes: a single parent for all flat codecs (#2132) 2021-12-07 01:31:07 -08:00
IndexPreTransform_c.cpp C_API: Improve PreTransformIndex (#1945) 2021-06-23 07:06:20 -07:00
IndexPreTransform_c.h C_API: Improve PreTransformIndex (#1945) 2021-06-23 07:06:20 -07:00
IndexReplicas_c.cpp Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
IndexReplicas_c.h Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
IndexScalarQuantizer_c.cpp Add IndexIVFScalarQuantizer for c_api (#1829) 2021-04-22 05:19:42 -07:00
IndexScalarQuantizer_c.h Add IndexIVFScalarQuantizer for c_api (#1829) 2021-04-22 05:19:42 -07:00
IndexShards_c.cpp Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
IndexShards_c.h Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
Index_c.cpp Add sa_code_size, sa_encode, and sa_decode to the C_API (#2367) 2022-06-29 12:02:51 -07:00
Index_c.h Add sa_code_size, sa_encode, and sa_decode to the C_API (#2367) 2022-06-29 12:02:51 -07:00
MetaIndexes_c.cpp Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
MetaIndexes_c.h Improve meta indexes (#1982) 2021-09-08 10:02:47 -07:00
VectorTransform_c.cpp Impl IndexPreTransform for c_api (#1816) 2021-04-22 05:27:36 -07:00
VectorTransform_c.h Classes inherited from VectorTransform for c_api (#1869) 2021-05-12 07:34:39 -07:00
clone_index_c.cpp Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
clone_index_c.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
error_c.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
error_impl.cpp Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
error_impl.h
example_c.c Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
faiss_c.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
index_factory_c.cpp Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
index_factory_c.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00
index_io_c.cpp Summary: Add Binary Index i.o to c_api (#2233) 2022-03-16 03:28:46 -07:00
index_io_c.h Summary: Add Binary Index i.o to c_api (#2233) 2022-03-16 03:28:46 -07:00
macros_impl.h Enable clang-format + autofix. 2021-02-25 04:46:10 -08:00