Package: faissR 0.99.13
faissR: FAISS-Backed Nearest Neighbours, Graph Clustering, kNN Models, and k-Means
Native nearest-neighbour search, graph construction, graph clustering, k-nearest neighbour prediction, and k-means helpers for large dimensionality reduction workflows in high-throughput biological data analysis, including single-cell, flow cytometry, imaging, and mass spectrometry applications. The package requires the FAISS C++ library for all builds, including CPU-only indexes, and can optionally use FAISS GPU indexes with NVIDIA cuVS integration or direct RAPIDS cuVS/CUDA indexes on NVIDIA machines. CPU-only systems do not need NVIDIA libraries, but NVIDIA CUDA/cuVS libraries are mandatory when a GPU-enabled build is explicitly requested. Supervised kNN models use knn(Xtrain, Ytrain) and predict(), or knn(Xtrain, Ytrain, Xtest) for immediate prediction. Class probabilities are returned through predict(type = "prob") for kNN classification models.
Authors:
faissR_0.99.13.tar.gz
faissR_0.99.13.tgz(r-4.6-x86_64)faissR_0.99.13.tgz(r-4.6-arm64)faissR_0.99.13.tgz(r-4.5-x86_64)faissR_0.99.13.tgz(r-4.5-arm64)
faissR_0.99.13.tar.gz(r-4.7-arm64)faissR_0.99.13.tar.gz(r-4.7-x86_64)faissR_0.99.13.tar.gz(r-4.6-arm64)faissR_0.99.13.tar.gz(r-4.6-x86_64)
faissR_0.99.13.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
faissR/json (API)
| # Install 'faissR' in R: |
| install.packages('faissR', repos = c('https://biocstaging.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/tkcaccia/faissr/issues
softwareinfrastructuregpusinglecellflowcytometrymassspectrometryimagingmassspectrometryproteomicsclusteringdimensionreductionclassificationfortrancppopenmp
Last updated from:dbc5826564. Checks:1 WARNING, 9 OK, 4 ERROR. Indexed: yes.
A new build is currently in progress.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| bioc-checks | WARNING | 190 | ||
| linux-devel-arm64 | OK | 248 | ||
| linux-devel-x86_64 | OK | 228 | ||
| source / vignettes | OK | 300 | ||
| linux-release-arm64 | OK | 234 | ||
| linux-release-x86_64 | OK | 241 | ||
| macos-release-arm64 | ERROR | 131 | ||
| macos-release-x86_64 | ERROR | 361 | ||
| macos-oldrel-arm64 | ERROR | 134 | ||
| macos-oldrel-x86_64 | ERROR | 394 | ||
| windows-devel | OK | 80 | ||
| windows-release | OK | 66 | ||
| windows-oldrel | OK | 69 | ||
| wasm-release | OK | 147 |
Exports:backend_infocandidate_knncuda_availablecugraph_availablecuvs_availablefaiss_availablefaiss_gpu_availablefast_kmeansgpu_knn_to_hostgraph_clusterknnknn_graphnnnn_capabilitiesnn_gpu
Dependencies:Rcpp
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Summarize native neighbour-search backend availability | backend_info |
| Select nearest neighbours from a candidate matrix | candidate_knn |
| Check whether the native CUDA backend is available | cuda_available |
| Check whether the RAPIDS libcugraph backend is available | cugraph_available |
| Check whether the RAPIDS cuVS backend is available | cuvs_available |
| Check whether the real FAISS C++ backend is available | faiss_available |
| Check whether FAISS GPU support is available | faiss_gpu_available |
| Fast k-means clustering | fast_kmeans |
| Copy a GPU-resident KNN result to host matrices | gpu_knn_to_host |
| Cluster a nearest-neighbour graph without igraph | graph_cluster print.faissR_graph_cluster |
| Fit or apply a k-nearest-neighbour classifier or regressor | knn |
| Build a native nearest-neighbour graph | knn_graph |
| Nearest neighbors from row-wise matrices | nn |
| Nearest-neighbour method capabilities | nn_capabilities |
| GPU-resident tuned nearest-neighbour search | nn_gpu |
| Predict from a faissR kNN model | predict.faissR_knn_model |
