Datatamer / Datatamer/tamr-client

Documentation for pair_matching_model() predict() functionality is misleading

Open
#341 0 comments 0 reactions 0 assignees View on GitHub
📝 Docs good first issue
Dominant language
Python
Stars
11
Forks
24
PR merge metrics
No merged PRs in 30d

Description

# 🐛 bug report

The documentation for pair_matching_model.predict() states that this updates clusters however this is incorrect - this API call only applies the current ML model to generate predictions for the current pairs.

## 🤔 Expected Behavior

Documentation should either remove the reference to predict (as it exists within MachineLearningModel section) or explain that calling predict() will apply the current ML model to generate labels for unverified pairs/records.

From MachineLearningModel:

> predict(**options)
> Suggest labels for unverified records.

## 😯 Current Behavior

Within the developer interface:
> pair_matching_model()
> Machine learning model for pair-matching for this Mastering project. Learns from verified labels and predicts categorization labels for unlabeled pairs.
>
> Calling predict() from this dataset will produce new (unpublished) clusters. These clusters are displayed on the “Clusters” page in the Tamr UI.

## 💁 Possible Solution

## 🔦 Context

The current documentation makes it difficult to understand what different calls are achieving in the standard mastering workflow.

## 💻 Code Sample

## 🌍 Your Environment

| Software | Version(s) |
| ----------------- | ---------- |
| tamr-unify-client | 0.9.0
| Tamr server |
| Python |
| Operating System |

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.