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. Семечко для псевдослучайного числа, используемого для инициализации центров. |
use_mini_batch | Булево значение, указывающее, использовать ли алгоритм мини-пакетных k-средних. См. объяснение выше. |
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.ExportOutput и входные данные всегда являются входными приемниками, предоставленными serving_input_receiver_fn.
Для обучения и оценки train_op хранится в дополнительной коллекции, а потеря, метрики и предсказания включаются в SignatureDef для рассматриваемого режима.
Дополнительные ресурсы могут быть записаны в SavedModel через аргумент assets_extra. Это должен быть словарь, где каждый ключ задаёт путь назначения (включая имя файла) относительно каталога assets.extra. Соответствующее значение задаёт полный путь исходного файла, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
| Аргументы | |
|---|---|
export_dir_base | Строка, содержащая каталог, в котором будут созданы каталоги подкаталогов со временем, содержащие экспортированные SavedModelы. |
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 (по умолчанию), выбирается самый последний контрольный пункт, найденный в каталоге модели. |
| Возвращает | |
|---|---|
| Путь к экспортированному каталогу в виде объекта байтов. |
| Исключения | |
|---|---|
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 см. Использование формата SavedModel.
Этот метод создаёт новую графу, сначала вызывая serving_input_receiver_fn для получения признаков Tensor, а затем вызывая Estimator's 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.ExportOutput, а входные данные всегда являются входными приемниками, предоставленными 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 для полного описания.
| Аргументы | |
|---|---|
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 (по умолчанию), выбирается самый последний контрольный пункт, найденный в каталоге модели. |
experimental_mode | Значение tf.estimator.ModeKeys, указывающее, какой режим будет экспортирован. Обратите внимание, что эта функция является экспериментальной. |
| Возвращает | |
|---|---|
| Путь к экспортированному каталогу в виде объекта байтов. |
| Исключения | |
|---|---|
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's 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.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, атрибуты с значениями по умолчанию будут удалены из NodeDefов. Подробное руководство см. в Удалении атрибутов по умолчанию. |
| Возвращаемое значение | |
|---|---|
| Путь к каталогу экспорта в виде объекта bytes. |
| Исключения | |
|---|---|
ValueError | если не указана serving_input_receiver_fn, не указаны export_outputs или контрольная точка не найдена. |
get_variable_names
get_variable_names()
Возвращает список всех имен переменных в этой модели.
| Возвращаемое значение | |
|---|---|
| Список имен. |
| Исключения | |
|---|---|
ValueError | Если модель еще не создала контрольную точку. |
get_variable_value
get_variable_value(
name
)
Возвращает значение переменной по имени.
| Аргументы | |
|---|---|
name | Строка или список строк, имя тензора. |
| Возвращаемое значение | |
|---|---|
| Массив NumPy - значение тензора. |
| Исключения | |
|---|---|
ValueError | Если модель еще не создала контрольную точку. |
latest_checkpoint
latest_checkpoint()
Находит имя файла последней сохраненной контрольной точки в model_dir.
| Возвращаемое значение | |
|---|---|
Полный путь к последней контрольной точке или None если контрольная точка не найдена. |
predict
predict(
input_fn,
predict_keys=None,
hooks=None,
checkpoint_path=None,
yield_single_examples=True
)
Возвращает предсказания для заданных признаков.
Обратите внимание, что чередование двух результатов predict не работает. См.: issue/20506
| Аргументы | |
|---|---|
input_fn | Функция, которая строит признаки. Предсказание продолжается до тех пор, пока input_fn не произойдет исключение конца ввода (tf.errors.OutOfRangeError или StopIteration). См. Предварительно подготовленные оценщики для получения дополнительной информации. Функция должна строить и возвращать одно из следующего:
|
predict_keys | Список str, имена ключей для предсказания. Используется, если tf.estimator.EstimatorSpec.predictions является dict. Если используется predict_keys, остальные предсказания будут отфильтрованы из словаря. Если None, возвращаются все. |
hooks | Список экземпляров подклассов tf.train.SessionRunHook. Используются для обратных вызовов внутри вызова предсказания. |
checkpoint_path | Путь к конкретной контрольной точке для предсказания. Если None, используется последняя контрольная точка в model_dir. Если в Variables нет контрольных точек, предсказание выполняется с только что инициализированными 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.
| Args | |
|---|---|
input_fn | Функция, предоставляющая входные данные для обучения в виде мини-пакетов. См. Предопределенные оценщики для получения дополнительной информации. Функция должна создавать и возвращать один из следующих объектов:
|
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. Используется для обратных вызовов, которые выполняются непосредственно перед или после сохранения контрольных точек. |
| Returns | |
|---|---|
self, для цепочки вызовов. |
| Raises | |
|---|---|
ValueError | Если оба steps и max_steps не являются None. |
ValueError | Если любой из steps или max_steps <= 0. |
transform
transform(
input_fn
)
Преобразует каждую входную точку в её расстояния до всех центров кластеров.
Обратите внимание, что если distance_metric=KMeansClustering.SQUARED_EUCLIDEAN_DISTANCE, эта функция возвращает квадрат расстояния Евклида, в то время как соответствующая функция sklearn возвращает расстояние Евклида.
| Args | |
|---|---|
input_fn | Входные точки. См. tf.estimator.Estimator.predict. |
| Yields | |
|---|---|
| Расстояния от каждой входной точки до каждого центра кластера. |
| Переменные класса | |
|---|---|
| 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' |
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/compat/v1/estimator/experimental/KMeans