diff --git a/lib/scholar/cluster/optics.ex b/lib/scholar/cluster/optics.ex index 4d991b2f..1cd451cf 100644 --- a/lib/scholar/cluster/optics.ex +++ b/lib/scholar/cluster/optics.ex @@ -25,14 +25,14 @@ defmodule Scholar.Cluster.OPTICS do max_eps: [ type: {:custom, Scholar.Options, :beta, []}, doc: """ - The maximum distance between two samples for one to be considered as in the neighborhood of the other. + The maximum distance between two samples for one to be considered as in the neighborhood of the other. Default value of Nx.Constants.infinity() will identify clusters across all scales. """ ], eps: [ type: {:custom, Scholar.Options, :beta, []}, doc: """ - The maximum distance between two samples for one to be considered as in the neighborhood of the other. + The maximum distance between two samples for one to be considered as in the neighborhood of the other. By default it assumes the same value as max_eps. """ ], @@ -58,7 +58,7 @@ defmodule Scholar.Cluster.OPTICS do @opts_schema NimbleOptions.new!(opts) @doc """ - Perform OPTICS clustering for `x` which is tensor of `{n_samples, n_features} shape. + Perform OPTICS clustering for `x` which is tensor of `{n_samples, n_features}` shape. ## Options @@ -67,7 +67,7 @@ defmodule Scholar.Cluster.OPTICS do ## Return Values The function returns a labels tensor of shape `{n_samples}`. - Cluster labels for each point in the dataset given to fit(). + Cluster labels for each point in the dataset given to `fit`. Noisy samples are labeled as -1. ## Examples diff --git a/lib/scholar/preprocessing.ex b/lib/scholar/preprocessing.ex index ccdfb56a..eaabd581 100644 --- a/lib/scholar/preprocessing.ex +++ b/lib/scholar/preprocessing.ex @@ -140,7 +140,8 @@ defmodule Scholar.Preprocessing do end @doc """ - It is a shortcut for `Scholar.Preprocessing.OrdinalEncoder.fit_transform/2`. + It is a shortcut for `Scholar.Preprocessing.OrdinalEncoder.fit_transform/1`. + See `Scholar.Preprocessing.OrdinalEncoder` for more information. ## Examples diff --git a/mix.exs b/mix.exs index e6c67a34..a98ea77b 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule Scholar.MixProject do use Mix.Project @source_url "https://github.com/elixir-nx/scholar" - @version "0.3.1" + @version "0.4.0" def project do [