Spec-Zone.ru › TensorFlow 1.15

tf.contrib.timeseries.ARRegressor

Оценщик для (необязательно нелинейной) авторегрессионной модели.

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

tf.contrib.timeseries.ARRegressor(
    periodicities, input_window_size, output_window_size, num_features,
    exogenous_feature_columns=None, num_time_buckets=10,
    loss=ar_model.ARModel.NORMAL_LIKELIHOOD_LOSS, hidden_layer_sizes=None,
    anomaly_prior_probability=None, anomaly_distribution=None, optimizer=None,
    model_dir=None, config=None
)

ARRegressor — это модель на основе окон, принимающая фиксированные окна длиной input_window_size и выводящая фиксированные окна длиной output_window_size. Эти два параметра должны суммироваться до размера окна, переданного в Chunker для создания input_fn для обучения или оценки. RandomWindowInputFn рекомендуется как для обучения, так и для оценки, хотя для детерминированной оценки его можно использовать с начальным значением.

Аргументы
periodicities Периодичность входных данных в тех же единицах, что и временной признак. Примечание: это может быть одно значение или список значений для нескольких периодичностей.
input_window_size Количество прошлых временных шагов данных, которые необходимо рассмотреть при регрессии.
output_window_size Количество будущих временных шагов для прогнозирования. Обратите внимание, что эмпирически установка значения > 1, кажется, улучшает подгонку.
num_features Размерность временного ряда (один для унивариантного, более одного для многовариантного).
exogenous_feature_columns Список tf.feature_column (например, tf.feature_column.embedding_column) соответствующих экзогенным признакам, которые предоставляют дополнительную информацию для модели, но не являются частью ряда, подлежащего прогнозированию. Передается в tf.compat.v1.feature_column.input_layer.
num_time_buckets Количество ведер, в которые разбивать (время % периодичность) для генерации временных признаков.
loss Функция потерь, используемая для обучения. В настоящее время поддерживаются значения SQUARED_LOSS и NORMAL_LIKELIHOOD_LOSS. Обратите внимание, что для NORMAL_LIKELIHOOD_LOSS мы обучаем также член ковариации. Для SQUARED_LOSS оценка потерь сообщается на основе не масштабированных наблюдений и прогнозов, а потери обучения вычисляются на нормализованных данных.
hidden_layer_sizes Список размеров скрытых слоев.
anomaly_prior_probability Если указано, строит модель смешения, в рамках которой аномалии (моделируемые с anomaly_distribution) имеют эту вероятность априори. Смотрите AnomalyMixtureARModel.
anomaly_distribution Не может быть указано, если не указано anomaly_prior_probability и не равно None. Управляет распределением аномалий в рамках модели смешения. В настоящее время либо ar_model.AnomalyMixtureARModel.GAUSSIAN_ANOMALY , либо ar_model.AnomalyMixtureARModel.CAUCHY_ANOMALY. См. AnomalyMixtureARModel. По умолчанию GAUSSIAN_ANOMALY.
optimizer Алгоритм оптимизации для обучения, наследуемый от tf.train.Optimizer. По умолчанию — Adagrad со скоростью 0,1.
model_dir См. Estimator.
config См. Estimator.
Исключения
ValueError При некорректных комбинациях аргументов.
Атрибуты
config
model_dir
model_fn Возвращает model_fn, привязанный к self.params.
params

Методы

build_one_shot_parsing_serving_input_receiver_fn

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

build_one_shot_parsing_serving_input_receiver_fn(
    filtering_length, prediction_length, default_batch_size=None,
    values_input_dtype=None, truncate_values=False
)

Создаёт input_receiver_fn для export_savedmodel, принимающий tf.Examples.

Совместимо только с OneShotPredictionHead (см. head).

Аргументы
filtering_length Количество временных шагов, используемых в качестве входных данных для модели, для которых предоставляются значения. Если предоставлено более filtering_length значений (через truncate_values), используются только первые filtering_length значений.
prediction_length Количество временных шагов, запрашиваемых для прогнозов модели. Для этих шагов необходимо предоставить значения времени и всех экзогенных признаков.
default_batch_size При указании, должно быть скалярное целое число. Устанавливает размер пакета в статической информации о форме всех тензоров признаков, что означает, что экспортированная модель будет принимать только этот размер пакета. Если None (по умолчанию), статическая информация о размерах пакетов не указывается.
values_input_dtype Необязательное указание типа данных для значений в протоколах tf.Example (либо float32, либо int64, так как это числовые типы, поддерживаемые tf.Example). После парсинга значения преобразуются в тип данных модели (float32 или float64).
truncate_values Если True, ожидает filtering_length + prediction_length значений, но использует только первые filtering_length. Если False (по умолчанию), требуется ровно filtering_length значений.
Возвращает
input_receiver_fn, который можно передать в export_savedmodel оценщика.

Ожидает признаки, содержащиеся в векторе сериализованных tf.Examples с размерностью размер пакета, каждый tf.Example содержит признаки с такими размерностями: время: [длина_фильтрации + длина_прогнозирования] целые значения: [длина_фильтрации, количество_признаков] числа с плавающей точкой. Если truncate_values равно True, ожидает filtering_length + prediction_length значений, но использует только первые filtering_length. все экзогенные признаки: длина_фильтрации + длина_прогнозирования, ...

build_raw_serving_input_receiver_fn

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

build_raw_serving_input_receiver_fn(
    default_batch_size=None, default_series_length=None
)

Создаёт input_receiver_fn для export_savedmodel, принимающий массивы.

Автоматически создаёт заглушки для экзогенных FeatureColumn , переданных в модель.

Аргументы
default_batch_size При указании, должно быть скалярное целое число. Устанавливает размер пакета в статической информации о форме всех тензоров признаков, что означает, что экспортированная модель будет принимать только этот размер пакета. Если None (по умолчанию), статическая информация о размерах пакетов не указывается.
default_series_length При указании, должно быть скалярное целое число. Устанавливает длину ряда в статической информации о форме всех тензоров признаков, что означает, что экспортированная модель будет принимать только эту длину ряда. Если None (по умолчанию), статическая информация о длине ряда не указывается.
Возвращает
input_receiver_fn, который можно передать в export_savedmodel оценщика.

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 Функция, которая строит входные данные для оценки. См. Предопределённые оценщики для получения дополнительной информации. Функция должна создавать и возвращать один из следующих объектов: * Объект tf.data.Dataset: Выходы объекта Dataset должны быть кортежем (features, labels) с теми же ограничениями, что и ниже. * Кортеж (features, labels): где features — это tf.Tensor или словарь имен признаков (строки) к Tensor, а labels — это Tensor или словарь имён меток (строки) к Tensor. Оба features и labels используются model_fn. Они должны удовлетворять ожиданиям model_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'}.

Аргументы
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 (по умолчанию), выбирается последний контрольный пункт, найденный в каталоге модели.
Возвращаемые значения
Строка пути к экспортированному каталогу.
Исключения
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 с оценщиками.

Этот метод строит новую диаграмму, сначала вызвав 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.ExportOutputs, а входы всегда являются получателями ввода, предоставляемыми serving_input_receiver_fn.

Дополнительные ресурсы могут быть записаны в SavedModel через аргумент assets_extra. Это должен быть словарь, где каждый ключ задаёт путь назначения (включая имя файла) относительно каталога assets.extra. Соответствующее значение задаёт полный путь исходного файла для копирования. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.

Параметр experimental_mode может быть использован для экспорта одной диаграммы train/eval/predict как SavedModel. См. experimental_export_all_saved_models для полного описания.

Аргументы
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, указывающее, какой режим будет экспортирован. Обратите внимание, что эта функция экспериментальная.
Возвращаемые значения
Строка пути к экспортированному каталогу.
Исключения
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 в указанный каталог. (устаревшее)

Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: переименуйте функцию, используйте export_saved_model вместо неё.

Для подробного руководства см. Использование 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 Строка, содержащая каталог, в котором будут созданы подкаталоги с отметкой времени, содержащие экспортированные 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 (по умолчанию), выбирается самый последний контрольный пункт, найденный в каталоге модели.
strip_default_attrs Булево значение. Если True, атрибуты со значениями по умолчанию будут удалены из NodeDefs. Для подробного руководства см. Удаление атрибутов со значениями по умолчанию.
Возвращает
Путь к экспортированному каталогу.
Исключения
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). См. Предварительно подготовленные Estimators для получения дополнительной информации. Функция должна создать и вернуть одно из следующих:
  • Объект tf.data.Dataset: Выходы объекта Dataset должны соответствовать требованиям ниже.
  • признаки: тензор tf.Tensor или словарь имён признаков к Tensor. Признаки потребляются model_fn. Они должны удовлетворять ожиданиям model_fn от входных данных.
  • Кортеж, в этом случае извлекается первый элемент как признаки.
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.

train

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

train(
    input_fn, hooks=None, steps=None, max_steps=None, saving_listeners=None
)

Обучает модель с использованием обучающих данных input_fn.

Аргументы
input_fn Функция, предоставляющая входные данные для обучения в виде мини-батчей. См. Предопределённые оценщики для получения дополнительной информации. Функция должна строить и возвращать один из следующих объектов:
  • Объект tf.data.Dataset: Выходные данные объекта Dataset должны быть кортежем (features, labels) с теми же ограничениями, что и ниже.
  • Кортеж (features, labels): где features представляет собой tf.Tensor или словарь имён признаков в виде строк к Tensor, а labels — Tensor или словарь имён меток в виде строк к Tensor. Оба features и labels потребляются model_fn. Они должны соответствовать ожиданиям model_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. Используется для обратных вызовов, которые выполняются непосредственно перед или после сохранения контрольных точек.
Возвращаемое значение
self, для цепочки вызовов.
Исключения
ValueError Если оба steps и max_steps не являются None.
ValueError Если либо steps или max_steps <= 0.

© 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/timeseries/ARRegressor

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API