Skip to content

Commit

Permalink
[clustering.jl] Docstring added 📄
Browse files Browse the repository at this point in the history
  • Loading branch information
shayandavoodii committed Mar 14, 2024
1 parent 01167dc commit 2cbaa0a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/clustering.jl
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
"""
cepsclustering(cc::AbstractMatrix, k::Integer)
Perform clustering of cepstral coefficients using k-medoids algorithm.
!!! note
This function can be used only after importing the `Clustering` package.
# Arguments
- `cc::AbstractMatrix`: A matrix of cepstral coefficients.
- `k::Integer`: Maximum number of clusters to be examined (to find the optimal number of clusters).
# Returns
- A vector of vectors, where each vector contains the indices of the cepstral coefficients in \
the corresponding cluster.
"""
function cepsclustering end

0 comments on commit 2cbaa0a

Please sign in to comment.