This documentation is sourced from a third-party project and is not maintained by pgEdge.
Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
git clone https://github.com/pgvector/pgvector.git
cd pgvector
make
make install
To run all tests:
make installcheck # regression tests
make prove_installcheck # TAP tests
To run single tests:
make installcheck REGRESS=functions # regression test
make prove_installcheck PROVE_TESTS=test/t/001_ivfflat_wal.pl # TAP test
To enable assertions:
make clean && PG_CFLAGS="-DUSE_ASSERT_CHECKING" make && make install
To enable benchmarking:
make clean && PG_CFLAGS="-DIVFFLAT_BENCH" make && make install
To show memory usage:
make clean && PG_CFLAGS="-DHNSW_MEMORY -DIVFFLAT_MEMORY" make && make install
To get k-means metrics:
make clean && PG_CFLAGS="-DIVFFLAT_KMEANS_DEBUG" make && make install
Resources for contributors