tf.contrib.learn.KMeansClustering

Оценщик для кластеризации K-средних.

Наследуется от: Estimator

tf.contrib.learn.KMeansClustering(
    num_clusters, model_dir=None, initial_clusters=RANDOM_INIT,
    distance_metric=SQUARED_EUCLIDEAN_DISTANCE, random_seed=0, use_mini_batch=True,
    mini_batch_steps_per_iteration=1, kmeans_plus_plus_num_retries=2,
    relative_tolerance=None, config=None
)

ЭТОТ КЛАСС УСТЕРЕЛ. См. contrib/learn/README.md для общих инструкций по миграции.

Аргументы
`num_clusters`	количество кластеров для обучения.
`model_dir`	каталог для сохранения результатов модели и файлов журналов.
`initial_clusters`	определяет, как инициализировать кластеры для обучения. См. clustering_ops.kmeans для возможных значений.
`distance_metric`	метрика расстояния, используемая для кластеризации. См. clustering_ops.kmeans для возможных значений.
`random_seed`	Целое число Python. Зерно для PRNG, используемого для инициализации центров.
`use_mini_batch`	Если True, используется алгоритм mini-batch k-means. В противном случае предполагается полный пакет.
`mini_batch_steps_per_iteration`	количество шагов после которого обновлённые центры кластеров синхронизируются с копией master. См. clustering_ops.py для получения дополнительной информации.
`kmeans_plus_plus_num_retries`	Для каждой точки, которая сэмплируется во время инициализации kmeans++, этот параметр задаёт количество дополнительных точек для выборки из текущего распределения перед выбором лучшей. Если указано отрицательное значение, используется эвристика для выборки O(log(num_to_sample)) дополнительных точек.
`relative_tolerance`	относительная толерантность изменения потерь между итерациями. Останавливает обучение, если потери меняются меньше этого значения. Обратите внимание, что это может не работать корректно, если use_mini_batch=True.
`config`	См. Оценщик

Атрибуты
`config`
`model_dir`	Возвращает путь, в котором процесс eval будет искать контрольные точки.
`model_fn`	Возвращает model_fn, привязанный к self.params.

Методы

`clusters`

Просмотреть исходный код

clusters()

Возвращает центры кластеров. (устарело)

`evaluate`

Просмотреть исходный код

evaluate(
    x=None, y=None, input_fn=None, feed_fn=None, batch_size=None, steps=None,
    metrics=None, name=None, checkpoint_path=None, hooks=None, log_progress=True
)

См. Evaluable. (устаревшие аргументы)

Исключения
`ValueError`	Если хотя бы один из `x` или `y` предоставлен, и хотя бы один из `input_fn` или `feed_fn` предоставлен. Или если `metrics` не является `None` или `dict`.

`export`

Просмотреть исходный код

export(
    export_dir, input_fn=export._default_input_fn, input_feature_key=None,
    use_deprecated_input_fn=True, signature_fn=None, prediction_key=None,
    default_batch_size=1, exports_to_keep=None, checkpoint_path=None
)

Экспортирует граф вывода в указанный каталог. (устарело)

Аргументы
`export_dir`	Строка, содержащая каталог для записи экспортированной графы и контрольных точек.
`input_fn`	Если `use_deprecated_input_fn` равно True, то функция, которая, принимая `Tensor` строк `Example`, анализирует их в признаки, которые затем передаются в модель. В противном случае функция, которая не принимает аргументов и возвращает кортеж (признаки, метки), где признаки — это словарь строк с ключами к `Tensor`, а метки — это `Tensor`, который в настоящее время не используется (и поэтому может быть `None`).
`input_feature_key`	Используется только если `use_deprecated_input_fn` равно false. Строковый ключ в словаре признаков, возвращаемый `input_fn`, который соответствует исходным `Example` строкам `Tensor`, которые будут приняты экспортированной моделью в качестве входных данных. Может быть только `None` если вы используете пользовательскую `signature_fn`, которая не использует первый аргумент (примеры).
`use_deprecated_input_fn`	Определяет формат подписи `input_fn`.
`signature_fn`	Функция, которая возвращает стандартную подпись и словарь подписей с именами, заданные `Tensor` строк `Example`, `dict` `Tensor` для признаков и `Tensor` или `dict` `Tensor` для прогнозов.
`prediction_key`	Ключ для тензора в словаре `predictions` (выход из `model_fn`) для использования в качестве входных данных для `predictions` в `signature_fn`. Необязательно. Если `None`, прогнозы будут переданы `signature_fn` без фильтрации.
`default_batch_size`	Значение по умолчанию для размера пакета `Example` placeholder.
`exports_to_keep`	Количество экспортов для сохранения.
`checkpoint_path`	путь к контрольной точке модели, которая будет экспортирована. Если `None` (что является значением по умолчанию), используется самая последняя контрольная точка в export_dir.

Возвращает
Путь к экспортированному каталогу. Примечание: эта функциональность была добавлена около 2016/09/25; клиентам, зависящим от возвращаемого значения, может потребоваться обработать случай, когда эта функция возвращает None, потому что подклассы не возвращают значение.

Возвращает

Путь к экспортированному каталогу. Примечание: эта функциональность была добавлена около 2016/09/25; клиентам, зависящим от возвращаемого значения, может потребоваться обработать случай, когда эта функция возвращает None, потому что подклассы не возвращают значение.

`export_savedmodel`

Просмотреть исходный код

export_savedmodel(
    export_dir_base, serving_input_fn, default_output_alternative_key=None,
    assets_extra=None, as_text=False, checkpoint_path=None,
    graph_rewrite_specs=(GraphRewriteSpec((tag_constants.SERVING,), ()),),
    strip_default_attrs=False
)

Экспортирует граф вывода в виде SavedModel в указанный каталог.

Аргументы
`export_dir_base`	Строка, содержащая каталог для записи экспортированной графы и контрольных точек.
`serving_input_fn`	Функция, которая не принимает аргументов и возвращает `InputFnOps`.
`default_output_alternative_key`	Имя головы для обслуживания, если не указано. Не требуется для моделей с одной головой.
`assets_extra`	Словарь, определяющий, как заполнить каталог assets.extra в экспортированном SavedModel. Каждый ключ должен указывать путь назначения (включая имя файла) относительно каталога assets.extra. Соответствующее значение указывает полный путь к исходному файлу, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как `{'my_asset_file.txt': '/path/to/my_asset_file.txt'}`.
`as_text`	Нужно ли записать протокол SavedModel в текстовом формате.
`checkpoint_path`	Путь к контрольной точке для экспорта. Если None (значение по умолчанию), выбирается самая последняя контрольная точка, найденная в каталоге модели.
`graph_rewrite_specs`	Итерируемый список `GraphRewriteSpec`. Каждый элемент создаст отдельный MetaGraphDef в экспортированном SavedModel, помеченный и переписанный как указано. По умолчанию один элемент, использующий стандартную метку обслуживания ("serve") и без перезаписи.
`strip_default_attrs`	Булево. Если `True`, атрибуты с значениями по умолчанию будут удалены из NodeDefs. Для подробного руководства см. Удаление атрибутов со значениями по умолчанию.

Возвращает
Путь к экспортированному каталогу.

Исключения
`ValueError`	если запрос содержит неизвестный export_type.

`fit`

Просмотреть исходный код

fit(
    x=None, y=None, input_fn=None, steps=None, batch_size=None, monitors=None,
    max_steps=None
)

См. Trainable. (устаревшие аргументы)

END_OF_DOCUMENT_MARKER

Исключения
`ValueError`	Если `x` или `y` не `None` , в то время как `input_fn` не `None`.
`ValueError`	Если оба `steps` и `max_steps` не `None`.

`get_params`

Просмотреть исходный код

get_params(
    deep=True
)

Получить параметры для этого оценщика.

Аргументы
`deep`	boolean, необязательно Если `True`, вернет параметры для этого оценщика и содержащихся подобъектов, которые являются оценщиками.

Возвращает
`params`	отображение строки к любому Параметры, имена которых сопоставлены с их значениями.

`get_variable_names`

Просмотреть исходный код

get_variable_names()

Возвращает список всех имён переменных в этой модели.

Возвращает
Список имён.

`get_variable_value`

Просмотреть исходный код

get_variable_value(
    name
)

Возвращает значение переменной, заданной по имени.

Аргументы
`name`	строка, имя тензора.

Возвращает
Массив NumPy - значение тензора.

`partial_fit`

Просмотреть исходный код

partial_fit(
    x=None, y=None, input_fn=None, steps=1, batch_size=None, monitors=None
)

Инкрементальное обучение на наборе образцов. (устаревшие аргументы)

Ожидается, что этот метод будет вызываться несколько раз последовательно на разных или одинаковых фрагментах набора данных. Это может реализовывать итеративное обучение или обучение вне ячейки/онлайн-обучение.

Это особенно полезно, когда весь набор данных слишком велик, чтобы поместиться в оперативную память одновременно. Или когда модель долго сходится, и вы хотите разбить обучение на подчасти.

Аргументы
`x`	Матрица формы [n_samples, n_features...]. Может быть итератором, который возвращает массивы признаков. Образцы входных данных для обучения модели. Если установлено, `input_fn` должно быть `None`.
`y`	Вектор или матрица [n_samples] или [n_samples, n_outputs]. Может быть итератором, который возвращает массив меток. Значения меток обучения (метки классов в классификации, вещественные числа в регрессии). Если установлено, `input_fn` должно быть `None`.
`input_fn`	Функция ввода. Если установлено, `x`, `y`, и `batch_size` должны быть `None`.
`steps`	Число шагов для обучения модели. Если `None`, обучаться вечно.
`batch_size`	Размер мини-пакета для использования на входе, по умолчанию первый размер `x`. Должно быть `None` , если `input_fn` предоставлен.
`monitors`	Список экземпляров подкласса `BaseMonitor`. Используется для обратных вызовов внутри цикла обучения.

Возвращает
`self`, для цепочки.

Исключения
`ValueError`	Если хотя бы один из `x` и `y` предоставлен, и `input_fn` предоставлен.

`predict`

Просмотреть исходный код

predict(
    x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=True,
    iterate_batches=False
)

Возвращает предсказания для заданных признаков. (устаревшие аргументы)

Аргументы
`x`	Матрица формы [n_samples, n_features...]. Может быть итератором, который возвращает массивы признаков. Образцы входных данных для обучения модели. Если установлено, `input_fn` должно быть `None`.
`input_fn`	Функция ввода. Если установлено, `x` и 'batch_size' должны быть `None`.
`batch_size`	Переопределяет размер пакета по умолчанию. Если установлено, 'input_fn' должно быть 'None'.
`outputs`	список `str`, имя выходного значения для предсказания. Если `None`, возвращает все.
`as_iterable`	Если True, возвращает итератор, который продолжает выдавать предсказания для каждого примера, пока входные данные не исчерпаны. Примечание: Входные данные должны завершиться, если вы хотите, чтобы итератор завершился (например, убедитесь, что передали num_epochs=1, если вы используете что-то вроде read_batch_features).
`iterate_batches`	Если True, выдавать всю партию сразу вместо разбиения партии на отдельные образцы. Актуально только когда as_iterable равно True.

Возвращает
Массив NumPy предсказанных классов или значений регрессии, если конструктор `model_fn` возвращает `Tensor` для `predictions` или массив NumPy массивов, если `model_fn` возвращает `dict`. Возвращает итератор предсказаний, если as_iterable равно True.

Исключения
`ValueError`	Если x и input_fn оба предоставлены или оба `None`.

`predict_cluster_idx`

Просмотреть исходный код

predict_cluster_idx(
    input_fn=None
)

Выдаёт предсказанные индексы кластеров. (устарело)

`score`

Просмотреть исходный код

score(
    input_fn=None, steps=None
)

Предсказывает полную сумму расстояний до ближайших кластеров. (устарело)

Обратите внимание, что эта функция отличается от соответствующей функции в sklearn, которая возвращает отрицательную сумму расстояний.

Аргументы
`input_fn`	см. predict.
`steps`	см. predict.

Возвращает
Полная сумма расстояний до ближайших кластеров.

`set_params`

Просмотреть исходный код

set_params(
    **params
)

Установить параметры этого оценщика.

Метод работает как с простыми оценщиками, так и с вложенными объектами (такими как конвейеры). У первых параметры имеют вид <component>__<parameter> , так что можно обновить каждый компонент вложенного объекта.

Аргументы
`**params`	Параметры.

Возвращает
self

Возможные исключения
`ValueError`	Если params содержат недопустимые имена.

`transform`

Просмотреть исходный код

transform(
    input_fn=None, as_iterable=False
)

Преобразует каждый элемент в расстояния до центров кластеров. (устарело)

Обратите внимание, что эта функция отличается от соответствующей функции в sklearn. Для метрики расстояния SQUARED_EUCLIDEAN sklearn возвращает расстояние EUCLIDEAN, а эта функция возвращает расстояние SQUARED_EUCLIDEAN.

Аргументы
`input_fn`	см. predict.
`as_iterable`	см. predict

Возвращает
Массив с тем же количеством строк, что и x, и столбцами num_clusters, содержащий расстояния до центров кластеров.

Переменные класса

ALL_SCORES = 'all_scores'
CLUSTERS = 'clusters'
CLUSTER_IDX = 'cluster_idx'
COSINE_DISTANCE = 'cosine'
KMEANS_PLUS_PLUS_INIT = 'kmeans_plus_plus'
LOSS_OP_NAME = 'kmeans_loss'
RANDOM_INIT = 'random'
SCORES = 'scores'
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/r1.15/api_docs/python/tf/contrib/learn/KMeansClustering