tf.compat.v1.estimator.experimental.KMeans
Оценщик для кластеризации K-средних.
Наследуется от: Estimator
tf.compat.v1.estimator.experimental.KMeans(
num_clusters, model_dir=None, initial_clusters=RANDOM_INIT,
distance_metric=SQUARED_EUCLIDEAN_DISTANCE, seed=None, use_mini_batch=True,
mini_batch_steps_per_iteration=1, kmeans_plus_plus_num_retries=2,
relative_tolerance=None, config=None, feature_columns=None
)
Пример:
import numpy as np
import tensorflow as tf
num_points = 100
dimensions = 2
points = np.random.uniform(0, 1000, [num_points, dimensions])
def input_fn():
return tf.compat.v1.train.limit_epochs(
tf.convert_to_tensor(points, dtype=tf.float32), num_epochs=1)
num_clusters = 5
kmeans = tf.compat.v1.estimator.experimental.KMeans(
num_clusters=num_clusters, use_mini_batch=False)
# train
num_iterations = 10
previous_centers = None
for _ in xrange(num_iterations):
kmeans.train(input_fn)
cluster_centers = kmeans.cluster_centers()
if previous_centers is not None:
print 'delta:', cluster_centers - previous_centers
previous_centers = cluster_centers
print 'score:', kmeans.score(input_fn)
print 'cluster centers:', cluster_centers
# map the input points to their clusters
cluster_indices = list(kmeans.predict_cluster_index(input_fn))
for i, point in enumerate(points):
cluster_index = cluster_indices[i]
center = cluster_centers[cluster_index]
print 'point:', point, 'is in cluster', cluster_index, 'centered at', center
Сохранённые SavedModel методом export_saved_model не включают центры кластеров. Однако, центры кластеров могут быть извлечены из последнего контрольного пункта, сохранённого во время обучения. Конкретно,
kmeans.cluster_centers()
эквивалентно
tf.train.load_variable(
kmeans.model_dir, KMeansClustering.CLUSTER_CENTERS_VAR_NAME)
| Аргументы | |
|---|---|
num_clusters | Целочисленный тензор, определяющий количество кластеров. Этот аргумент игнорируется, если initial_clusters является тензором или массивом NumPy. |
model_dir | Каталог для сохранения результатов модели и лог-файлов. |
initial_clusters | Указывает, как выбираются начальные центры кластеров. Один из следующих вариантов: * тензор или массив NumPy с начальными центрами кластеров. * вызываемый f(inputs, k) функция, которая выбирает и возвращает до k центров из входной партии. f может свободно возвращать любое количество центров от 0 до k. Она будет вызываться для последовательных входных партий по мере необходимости, пока все num_clusters центры не будут выбраны.
|
distance_metric | Метрика расстояния, используемая для кластеризации. Один из следующих вариантов: KMeansClustering.SQUARED_EUCLIDEAN_DISTANCE: Евклидово расстояние между векторами u и v определяется как \(||u - v||_2\) — квадратный корень из суммы квадратов абсолютных разностей элементов.KMeansClustering.COSINE_DISTANCE: Косинусное расстояние между векторами u и v определяется как \(1 - (u . v) / (||u||_2 ||v||_2)\). |
seed | Целое число Python. Зерно для PRNG, используемого для инициализации центров. |
use_mini_batch | Логический флаг, указывающий, следует ли использовать алгоритм mini-batch k-means. См. объяснение выше. |
mini_batch_steps_per_iteration | Количество шагов, после которых обновлённые центры кластеров синхронизируются с копией-мастером. Используется только если use_mini_batch=True. См. объяснение выше. |
kmeans_plus_plus_num_retries | Для каждой точки, выбранной при инициализации kmeans++, этот параметр задаёт количество дополнительных точек, которые нужно выбрать из текущего распределения, прежде чем выбрать наилучшую. Если указано отрицательное значение, используется эвристика для выборки O(log(num_to_sample)) дополнительных точек. Используется только если initial_clusters=KMeansClustering.KMEANS_PLUS_PLUS_INIT. |
relative_tolerance | Относительная толерантность изменения потерь между итерациями. Останавливает обучение, если потери меняются меньше этого значения. Это может не работать корректно, если use_mini_batch=True. |
config | См. tf.estimator.Estimator. |
feature_columns | Необязательное итерируемое множество, содержащее все столбцы признаков, используемые моделью. Все элементы множества должны быть экземплярами столбцов признаков, которые могут быть переданы в tf.feature_column.input_layer. Если это None, будут использованы все признаки. |
| Возбуждает | |
|---|---|
ValueError | Был передан недопустимый аргумент в initial_clusters или distance_metric. |
| Атрибуты | |
|---|---|
config | |
model_dir | |
model_fn | Возвращает model_fn, который привязан к self.params. |
params | |
Методы
cluster_centers
cluster_centers()
Возвращает центры кластеров.
eval_dir
eval_dir(
name=None
)
Показывает имя каталога, куда выгружаются метрики оценки.
| Аргументы | |
|---|---|
name | Название оценки, если пользователю нужно выполнить несколько оценок на разных наборах данных, например, на обучающих и тестовых данных. Метрики для разных оценок сохраняются в отдельных папках и отображаются отдельно в TensorBoard. |
| Возвращает | |
|---|---|
| Строка, представляющая путь к каталогу, содержащему метрики оценки. |
evaluate
evaluate(
input_fn, steps=None, hooks=None, checkpoint_path=None, name=None
)
Выполняет оценку модели с использованием данных оценки input_fn.
На каждом шаге вызывает input_fn, которая возвращает одну партию данных. Выполняет оценку до:
-
stepsпартий обработаны, или -
input_fnвозникает исключение конца ввода (tf.errors.OutOfRangeErrorилиStopIteration).
| Аргументы | |
|---|---|
input_fn | Функция, строящая входные данные для оценки. См. Предопределенные оценщики для получения дополнительной информации. Функция должна создавать и возвращать один из следующих объектов:
|
steps | Число шагов, для которых необходимо оценить модель. Если None, оценка выполняется до тех пор, пока input_fn не возникнет исключение конца ввода. |
hooks | Список экземпляров подкласса tf.train.SessionRunHook для обратных вызовов внутри вызова оценки. |
checkpoint_path | Путь к конкретному контрольному пункту для оценки. Если None, используется последний контрольный пункт в model_dir Если контрольных пунктов в model_dir нет, оценка выполняется с помощью только что инициализированных Variables вместо тех, которые восстановлены из контрольного пункта. |
name | Название оценки, если пользователю нужно выполнить несколько оценок на разных наборах данных, например, на обучающих и тестовых данных. Метрики для разных оценок сохраняются в отдельных папках и отображаются отдельно в TensorBoard. |
| Возвращает | |
|---|---|
Словарь, содержащий метрики оценки, указанные в model_fn с именами в качестве ключей, а также запись global_step, содержащую значение глобального шага, для которого была выполнена эта оценка. Для предопределённых оценщиков словарь содержит loss (средняя потеря на мини-партю) и average_loss (средняя потеря на образец). Предопределённые классификаторы также возвращают accuracy. Предопределённые регрессоры также возвращают label/mean и prediction/mean. |
| Возбуждает | |
|---|---|
ValueError | Если steps <= 0. |
experimental_export_all_saved_models
experimental_export_all_saved_models(
export_dir_base, input_receiver_fn_map, assets_extra=None, as_text=False,
checkpoint_path=None
)
Экспортирует SavedModel с tf.MetaGraphDefs для каждого запрошенного режима.
Для каждого режима, переданного через input_receiver_fn_map, этот метод строит новую графу, вызывая input_receiver_fn для получения признаков и меток Tensor. Затем этот метод вызывает Estimator's model_fn в переданном режиме для генерации графа модели на основе этих признаков и меток и восстанавливает указанный контрольный пункт (или, если его нет, последний контрольный пункт) в графе. Только один из режимов используется для сохранения переменных в SavedModel (порядок предпочтения: tf.estimator.ModeKeys.TRAIN, tf.estimator.ModeKeys.EVAL, затем tf.estimator.ModeKeys.PREDICT), так что до трёх tf.MetaGraphDefs сохраняются с одним набором переменных в одном каталоге экспорта SavedModel.
Для переменных и tf.MetaGraphDefs, создаётся каталог экспорта с отметкой времени ниже export_dir_base, и в нём записывается SavedModel содержащий tf.MetaGraphDef для данного режима и его соответствующих сигнатур.
Для предсказания экспортированный MetaGraphDef предоставит по одному SignatureDef для каждого элемента словаря export_outputs, возвращаемого методом model_fn, используя те же ключи. Один из этих ключей всегда tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY, указывающий, какая подпись будет использована, если в запросе об обслуживании не указана. Для каждой подписи выходные данные предоставляются соответствующими tf.estimator.export.ExportOutputs, а входные данные всегда — приемники входных данных, предоставляемые serving_input_receiver_fn.
Для обучения и оценки train_op хранится в дополнительной коллекции, а потери, метрики и предсказания включаются в SignatureDef для рассматриваемого режима.
Дополнительные ресурсы могут быть записаны в SavedModel с помощью аргумента assets_extra. Это должен быть словарь, где каждый ключ задаёт путь к целевому файлу (включая имя файла) относительно каталога assets.extra. Соответствующее значение — полный путь к исходному файлу, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
| Args | |
|---|---|
export_dir_base | Строка, содержащая каталог, в котором будут созданы подкаталоги со временем создания, содержащие экспортированные SavedModels. |
input_receiver_fn_map | Словарь сопоставлений tf.estimator.ModeKeys с input_receiver_fn отображениями, где input_receiver_fn — функция, не принимающая аргументов и возвращающая соответствующий подкласс InputReceiver. |
assets_extra | Словарь, определяющий способ заполнения каталога assets.extra в экспортированном SavedModel, или None если дополнительные ресурсы не нужны. |
as_text | нужно ли записывать протокол SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается последняя контрольная точка, найденная в каталоге модели. |
| Returns | |
|---|---|
| Путь к экспортированному каталогу в виде объекта байтов. |
| Raises | |
|---|---|
ValueError | если любой input_receiver_fn имеет значение None, не предоставлены export_outputs или не найдена контрольная точка. |
export_saved_model
export_saved_model(
export_dir_base, serving_input_receiver_fn, assets_extra=None, as_text=False,
checkpoint_path=None, experimental_mode=ModeKeys.PREDICT
)
Экспортирует график вывода в формате SavedModel в указанный каталог.
Подробное руководство см. в разделе SavedModel от Estimators.
Этот метод строит новый график, сначала вызвав serving_input_receiver_fn для получения признаков Tensor, а затем вызвав Estimator этого объекта model_fn для создания графика модели на основе этих признаков. Он восстанавливает заданную контрольную точку (или, если её нет, последнюю контрольную точку) в этот график в новой сессии. Наконец, он создаёт каталог экспорта со временем создания в каталоге export_dir_base, и записывает в него SavedModel, содержащий одну tf.MetaGraphDef сохранённую из этой сессии.
Экспортированный MetaGraphDef предоставит по одному SignatureDef для каждого элемента словаря export_outputs, возвращаемого методом model_fn, используя те же ключи. Один из этих ключей всегда tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY, указывающий, какая подпись будет использована, если в запросе об обслуживании не указана. Для каждой подписи выходные данные предоставляются соответствующими tf.estimator.export.ExportOutputs, а входные данные всегда — приемники входных данных, предоставляемые serving_input_receiver_fn.
Дополнительные ресурсы могут быть записаны в SavedModel с помощью аргумента assets_extra. Это должен быть словарь, где каждый ключ задаёт путь к целевому файлу (включая имя файла) относительно каталога assets.extra. Соответствующее значение — полный путь к исходному файлу, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
Параметр experimental_mode можно использовать для экспорта одного графика обучения/оценки/предсказания в виде SavedModel. См. experimental_export_all_saved_models для полного описания.
| Args | |
|---|---|
export_dir_base | Строка, содержащая каталог, в котором будут созданы подкаталоги со временем создания, содержащие экспортированные SavedModels. |
serving_input_receiver_fn | Функция, не принимающая аргументов и возвращающая tf.estimator.export.ServingInputReceiver или tf.estimator.export.TensorServingInputReceiver. |
assets_extra | Словарь, определяющий способ заполнения каталога assets.extra в экспортированном SavedModel, или None если дополнительные ресурсы не нужны. |
as_text | Нужно ли записывать протокол SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается последняя контрольная точка, найденная в каталоге модели. |
experimental_mode | Значение tf.estimator.ModeKeys, указывающее, какой режим будет экспортирован. Обратите внимание, что эта функция экспериментальная. |
| Возвращает | |
|---|---|
| Путь к экспортированной директории в виде объекта bytes. |
| Возможные исключения | |
|---|---|
ValueError | если не указан serving_input_receiver_fn, не указаны export_outputs, или контрольная точка не найдена. |
export_savedmodel
export_savedmodel(
export_dir_base, serving_input_receiver_fn, assets_extra=None, as_text=False,
checkpoint_path=None, strip_default_attrs=False
)
Экспортирует график вывода как SavedModel в указанную директорию. (устарело)
Для подробного руководства см. SavedModel от Estimators.
Этот метод создаёт новый граф, сначала вызвав serving_input_receiver_fn, чтобы получить значения признаков Tensor, а затем вызвав Estimator этого Estimator, чтобы сгенерировать граф модели на основе этих значений. Он восстанавливает указанную контрольную точку (или, если её нет, самую последнюю контрольную точку) в этот граф в новом сеансе. Наконец, он создаёт временную директорию экспорта в заданной export_dir_base, и записывает в неё SavedModel с единственной сохранённой tf.MetaGraphDef из этого сеанса.
Экспортированный MetaGraphDef предоставит один SignatureDef для каждого элемента словаря export_outputs, возвращённого model_fn, используя те же ключи. Один из этих ключей всегда tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY, указывающий, какая сигнатура будет использована, если при запросе обслуживания не указана конкретная. Для каждой сигнатуры выводы предоставляются соответствующими tf.estimator.export.ExportOutput, а входные данные всегда получаются от входных приемников, предоставленных serving_input_receiver_fn.
Дополнительные ресурсы могут быть записаны в SavedModel через аргумент assets_extra. Это должен быть словарь, где каждый ключ определяет путь назначения (включая имя файла) относительно директории assets.extra. Соответствующее значение указывает полный путь исходного файла, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
| Аргументы | |
|---|---|
export_dir_base | Строка, содержащая директорию, в которой будут созданы временные поддиректории с экспортированными SavedModel. |
serving_input_receiver_fn | Функция, которая не принимает аргументы и возвращает tf.estimator.export.ServingInputReceiver или tf.estimator.export.TensorServingInputReceiver. |
assets_extra | Словарь, определяющий, как заполнить директорию assets.extra в экспортированном SavedModel, или None если дополнительные ресурсы не требуются. |
as_text | Нужно ли записать прото SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается самая последняя контрольная точка, найденная в каталоге модели. |
strip_default_attrs | Булево значение. Если True, атрибуты с значениями по умолчанию будут удалены из NodeDefs. Для подробного руководства см. Удаление атрибутов с значениями по умолчанию. |
| Возвращает | |
|---|---|
| Путь к экспортированной директории в виде объекта bytes. |
| Возможные исключения | |
|---|---|
ValueError | если не указан serving_input_receiver_fn, не указаны export_outputs, или контрольная точка не найдена. |
get_variable_names
get_variable_names()
Возвращает список всех имён переменных в этой модели.
| Возвращает | |
|---|---|
| Список имён. |
| Возбуждает | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
get_variable_value
get_variable_value(
name
)
Возвращает значение переменной, заданной по имени.
| Аргументы | |
|---|---|
name | строка или список строк, имя тензора. |
| Возвращает | |
|---|---|
| Массив NumPy - значение тензора. |
| Возбуждает | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
latest_checkpoint
latest_checkpoint()
Находит имя файла последней сохранённой контрольной точки в model_dir.
| Возвращает | |
|---|---|
Полный путь к последней контрольной точке или None , если контрольная точка не найдена. |
predict
predict(
input_fn, predict_keys=None, hooks=None, checkpoint_path=None,
yield_single_examples=True
)
Возвращает предсказания для заданных признаков.
Обратите внимание, что чередование двух выходных данных predict не работает. См.: вопрос/20506
| Аргументы | |
|---|---|
input_fn | Функция, которая строит признаки. Предсказание продолжается, пока input_fn не сгенерирует исключение конца ввода (tf.errors.OutOfRangeError или StopIteration). См. Premade Estimators для получения дополнительной информации. Функция должна строить и возвращать одно из следующих:
|
predict_keys | список str, имена ключей для предсказания. Используется, если tf.estimator.EstimatorSpec.predictions является dict. Если используется predict_keys, то остальные предсказания будут отфильтрованы из словаря. Если None, возвращаются все. |
hooks | Список экземпляров подклассов tf.train.SessionRunHook. Используется для обратных вызовов внутри вызова предсказания. |
checkpoint_path | Путь к конкретной контрольной точке для предсказания. Если None, используется последняя контрольная точка в model_dir. Если в model_dir нет контрольных точек, предсказание выполняется с только что инициализированными Variables вместо восстановленных из контрольной точки. |
yield_single_examples | Если False, возвращаются все элементы пакета, возвращённые model_fn, вместо расщепления пакета на отдельные элементы. Это полезно, если model_fn возвращает некоторые тензоры, первая размерность которых не равна размеру пакета. |
| Возвращает | |
|---|---|
Вычисленные значения predictions тензоров. |
| Возбуждает | |
|---|---|
ValueError | Если длина пакета предсказаний не совпадает, а yield_single_examples равно True. |
ValueError | Если возникает конфликт между predict_keys и predictions. Например, если predict_keys не None, но tf.estimator.EstimatorSpec.predictions не dict. |
predict_cluster_index
predict_cluster_index(
input_fn
)
Находит индекс ближайшего центра кластера к каждой точке ввода.
| Аргументы | |
|---|---|
input_fn | Точки входа. См. tf.estimator.Estimator.predict. |
| Возвращает | |
|---|---|
| Индекс ближайшего центра кластера для каждой точки ввода. |
score
score(
input_fn
)
Возвращает сумму квадратов расстояний до ближайших кластеров.
Обратите внимание, что эта функция отличается от соответствующей функции в sklearn, которая возвращает отрицательную сумму.
| Аргументы | |
|---|---|
input_fn | Точки входа. См. tf.estimator.Estimator.evaluate. Извлекается только одна партия. |
| Возвращает | |
|---|---|
| Сумма квадратов расстояний от каждой точки в первой партии входных данных до её ближайшего центра кластера. |
train
train(
input_fn, hooks=None, steps=None, max_steps=None, saving_listeners=None
)
Обучает модель с использованием обучающих данных input_fn.
| Аргументы | |
|---|---|
input_fn | Функция, которая предоставляет входные данные для обучения в виде мини-пакетов. См. Premade Estimators для получения дополнительной информации. Функция должна строить и возвращать одно из следующих:
|
hooks | Список экземпляров подклассов tf.train.SessionRunHook . Используется для обратных вызовов внутри цикла обучения. |
steps | Количество шагов, для которых необходимо обучить модель. Если None, обучение будет продолжаться бесконечно или до тех пор, пока input_fn не сгенерирует ошибку tf.errors.OutOfRange или исключение StopIteration. steps работает инкрементально. Если вы вызовете train(steps=10) дважды, то обучение произойдёт в общей сложности за 20 шагов. Если OutOfRange или StopIteration произойдёт в середине, обучение остановится до 20 шагов. Если вы не хотите инкрементального поведения, установите max_steps. Если установлено, max_steps должно быть None. |
max_steps | Общее количество шагов, для которых необходимо обучить модель. Если None, обучение будет продолжаться бесконечно или до тех пор, пока input_fn не сгенерирует ошибку tf.errors.OutOfRange или исключение StopIteration. Если установлено, steps должно быть None. Если OutOfRange или StopIteration произойдёт в середине, обучение остановится до max_steps шагов. Два вызова train(steps=100) означают 200 итераций обучения. С другой стороны, два вызова train(max_steps=100) означают, что второй вызов не выполнит ни одной итерации, так как первый вызов выполнил все 100 шагов. |
saving_listeners | список CheckpointSaverListener объектов. Используется для обратных вызовов, которые выполняются непосредственно перед или после сохранения контрольной точки. |
| Возвращает | |
|---|---|
self, для цепочки. |
| Возможные исключения | |
|---|---|
ValueError | Если и steps, и max_steps не являются None. |
ValueError | Если либо steps, либо max_steps <= 0 . |
transform
transform(
input_fn
)
Преобразует каждую входную точку в свои расстояния до всех центров кластеров.
Обратите внимание, что если distance_metric=KMeansClustering.SQUARED_EUCLIDEAN_DISTANCE, эта функция возвращает квадрат расстояния Евклида, в то время как соответствующая функция sklearn возвращает расстояние Евклида.
| Аргументы | |
|---|---|
input_fn | Входные точки. См. tf.estimator.Estimator.predict. |
| Возвращаемые значения | |
|---|---|
| Расстояния от каждой входной точки до каждого центра кластера. |
| Переменные класса | |
|---|---|
| ALL_DISTANCES | 'all_distances' |
| CLUSTER_CENTERS_VAR_NAME | 'clusters' |
| CLUSTER_INDEX | 'cluster_index' |
| COSINE_DISTANCE | 'cosine' |
| KMEANS_PLUS_PLUS_INIT | 'kmeans_plus_plus' |
| RANDOM_INIT | 'random' |
| SCORE | 'score' |
| SQUARED_EUCLIDEAN_DISTANCE | 'squared_euclidean' |
© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/compat/v1/estimator/experimental/KMeans