Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo in umap target_weight parameter #3914

Merged
merged 3 commits into from
Jun 1, 2021
Merged

Fix typo in umap target_weight parameter #3914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe711d8
Fix typo in umap parameter
lowener May 28, 2021
aede216
Add exception for test_base_children_get_param_names
lowener Jun 1, 2021
0b78a3f
Fix style
lowener Jun 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cpp/include/cuml/manifold/umapparams.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class UMAPParams {

MetricType target_metric = CATEGORICAL;

float target_weights = 0.5;
float target_weight = 0.5;

uint64_t random_state = 0;

Expand Down
6 changes: 3 additions & 3 deletions cpp/src/umap/supervised.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,8 @@ void perform_categorical_intersection(
UMAPParams *params, std::shared_ptr<raft::mr::device::allocator> d_alloc,
cudaStream_t stream) {
float far_dist = 1.0e12; // target weight
if (params->target_weights < 1.0)
far_dist = 2.5 * (1.0 / (1.0 - params->target_weights));
if (params->target_weight < 1.0)
far_dist = 2.5 * (1.0 / (1.0 - params->target_weight));

categorical_simplicial_set_intersection<T, TPB_X>(rgraph_coo, y, stream,
far_dist);
Expand Down Expand Up @@ -314,7 +314,7 @@ void perform_general_intersection(const raft::handle_t &handle, value_t *y,
raft::sparse::COO<value_t> result_coo(d_alloc, stream);
general_simplicial_set_intersection<value_t, TPB_X>(
xrow_ind.data(), rgraph_coo, yrow_ind.data(), &cygraph_coo, &result_coo,
params->target_weights, d_alloc, stream);
params->target_weight, d_alloc, stream);

/**
* Remove zeros
Expand Down
22 changes: 16 additions & 6 deletions python/cuml/manifold/umap.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ cdef extern from "cuml/manifold/umapparams.h" namespace "ML":
int init,
int target_n_neighbors,
MetricType target_metric,
float target_weights,
float target_weight,
uint64_t random_state,
bool deterministic,
int optim_batch_size,
Expand Down Expand Up @@ -350,13 +350,14 @@ class UMAP(Base,
a=None,
b=None,
target_n_neighbors=-1,
target_weights=0.5,
target_weight=0.5,
target_metric="categorical",
handle=None,
hash_input=False,
random_state=None,
callback=None,
output_type=None):
output_type=None,
target_weights=None):

super().__init__(handle=handle,
verbose=verbose,
Expand Down Expand Up @@ -388,7 +389,16 @@ class UMAP(Base,
self.negative_sample_rate = negative_sample_rate
self.transform_queue_size = transform_queue_size
self.target_n_neighbors = target_n_neighbors
self.target_weights = target_weights
if target_weights is not None:
import warnings
warnings.warn("Parameter 'target_weights' is deprecated and"
" will be removed in 21.08. Please use"
" 'target_weight' instead. Setting 'target_weight'"
" as the curent 'target_weights' value",
DeprecationWarning)
self.target_weight = target_weights
else:
self.target_weight = target_weight

self.deterministic = random_state is not None

Expand Down Expand Up @@ -453,7 +463,7 @@ class UMAP(Base,
umap_params.target_metric = MetricType.EUCLIDEAN
else: # self.target_metric == "categorical"
umap_params.target_metric = MetricType.CATEGORICAL
umap_params.target_weights = <float> cls.target_weights
umap_params.target_weight = <float> cls.target_weight
umap_params.random_state = <uint64_t> cls.random_state
umap_params.deterministic = <bool> cls.deterministic

Expand Down Expand Up @@ -871,7 +881,7 @@ class UMAP(Base,
"a",
"b",
"target_n_neighbors",
"target_weights",
"target_weight",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might need to do an exception in test_base_children_get_param_names for the renamed parameter during 21.06, could you also create an issue to remove the parameter from 21.08 and the test exception?

"target_metric",
"hash_input",
"random_state",
Expand Down
2 changes: 2 additions & 0 deletions python/cuml/test/test_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ def test_base_children_get_param_names(child_class: str):

# Now ensure the base parameters are included in get_param_names
for name, param in sig.parameters.items():
if child_class == 'UMAP' and name == 'target_weights':
continue # Temporary fix to be removed in 21.08. See #3914

if (param.kind == inspect.Parameter.VAR_KEYWORD
or param.kind == inspect.Parameter.VAR_POSITIONAL):
Expand Down