Поделиться через


AzureFileDatastore Класс

Представляет хранилище данных, в котором содержатся сведения о подключении к хранилищу файлов Azure.

Не следует работать с этим классом напрямую. Чтобы создать хранилище данных этого типа, используйте метод register_azure_file_share.

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

Инициализируйте новое хранилище данных общей папки Azure.

Наследование
AzureFileDatastore

Конструктор

AzureFileDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint='core.windows.net', request_session=None)

Параметры

workspace
Workspace
Обязательно

Рабочая область, к которой принадлежит это хранилище данных.

name
str
Обязательно

Имя хранилища данных. Этот параметр может содержать только буквенно-цифровые знаки или символы "-" и "_".

container_name
str
Обязательно

Имя общей папки

account_name
str
Обязательно

Имя учетной записи хранения.

sas_token
str, <xref:optional>
значение по умолчанию: None

Маркер SAS для доступа к этому контейнеру. Значение по умолчанию — None.

account_key
str, <xref:optional>
значение по умолчанию: None

Ключ учетной записи хранения. Значение по умолчанию — None.

protocol
str, <xref:optional>
значение по умолчанию: None

Протокол, который используется для подключения к учетной записи хранения. При значении None по умолчанию используется HTTPS.

endpoint
str, <xref:optional>
значение по умолчанию: core.windows.net

Конечная точка контейнера больших двоичных объектов. При значении None по умолчанию используется core.windows.net.

request_session
<xref:requests.sessions.Session>, <xref:optional>
значение по умолчанию: None

Объект сеанса, который используется для HTTP-запросов. Значение по умолчанию — None.

workspace
Workspace
Обязательно

Рабочая область, к которой принадлежит это хранилище данных.

name
str
Обязательно

Имя хранилища данных. Этот параметр может содержать только буквенно-цифровые знаки или символы "-" и "_".

container_name
str
Обязательно

Имя общей папки

account_name
str
Обязательно

Имя учетной записи хранения.

sas_token
str, <xref:optional>
Обязательно

Маркер SAS для доступа к этому контейнеру. Значение по умолчанию — None.

account_key
str, <xref:optional>
Обязательно

Ключ учетной записи хранения. Значение по умолчанию — None.

protocol
str, <xref:optional>
Обязательно

Протокол, который используется для подключения к учетной записи хранения. При значении None по умолчанию используется HTTPS.

endpoint
str, <xref:optional>
Обязательно

Конечная точка контейнера больших двоичных объектов. При значении None по умолчанию используется core.windows.net.

request_session
<xref:requests.sessions.Session>, <xref:optional>
Обязательно

Объект сеанса, который используется для HTTP-запросов. Значение по умолчанию — None.

Методы

download

Загрузка данных из общей папки в локальную файловую систему.

upload

Отправка данных из локальной файловой системы в общую папку, на которую ссылается хранилище данных.

Примечание: Чтобы этот метод работал, для объекта хранилища данных должен быть указан ключ учетной записи или свойство маркера SAS. Если объект хранилища данных не содержит ни одной из форм учетной записи, этот метод завершится ошибкой. Более того, этот метод не рекомендуется и может быть удален в будущем. Чтобы отправить файлы в локальный каталог и создать FileDataset одним вызовом, мы рекомендуем использовать метод Dataset.File.upload_directory.

upload_files

Отправка данных из локальной файловой системы в общую папку, на которую ссылается хранилище данных.

Примечание: Это устаревший метод, который больше не будет поддерживаться. Вместо него рекомендуется использовать FileDatasetFactory.upload_directory.

download

Загрузка данных из общей папки в локальную файловую систему.

download(target_path, prefix=None, overwrite=False, show_progress=True)

Параметры

target_path
str
Обязательно

Локальный каталог для загрузки файла.

prefix
str, <xref:optional>
значение по умолчанию: None

Путь к папке в общей папке для загрузки. Если задано значение None, Машинное обучение Azure будет скачивать все данные в общей папке.

overwrite
bool, <xref:optional>
значение по умолчанию: False

Указывает, следует ли перезаписывать существующий файл.

show_progress
bool, <xref:optional>
значение по умолчанию: True

Указывает, демонстрировать ли в консоли ход выполнения загрузки.

Возвращаемое значение

Количество успешно загруженных файлов.

Возвращаемый тип

int

upload

Отправка данных из локальной файловой системы в общую папку, на которую ссылается хранилище данных.

Примечание: Чтобы этот метод работал, для объекта хранилища данных должен быть указан ключ учетной записи или свойство маркера SAS. Если объект хранилища данных не содержит ни одной из форм учетной записи, этот метод завершится ошибкой. Более того, этот метод не рекомендуется и может быть удален в будущем. Чтобы отправить файлы в локальный каталог и создать FileDataset одним вызовом, мы рекомендуем использовать метод Dataset.File.upload_directory.

upload(src_dir, target_path=None, overwrite=False, show_progress=True)

Параметры

src_dir
str
Обязательно

Локальный каталог для отправки.

target_path
str
Обязательно

Расположение в общей папке для отправки. При значении None данные отправляются в корневую папку.

overwrite
bool, <xref:optional>
Обязательно

Указывает, следует ли перезаписывать существующие файлы.

show_progress
bool, <xref:optional>
Обязательно

Указывает, демонстрировать ли в консоли ход отправки.

Возвращаемое значение

Экземпляр DataReference целевого пути, по которому выполнялась отправка.

Возвращаемый тип

upload_files

Отправка данных из локальной файловой системы в общую папку, на которую ссылается хранилище данных.

Примечание: Это устаревший метод, который больше не будет поддерживаться. Вместо него рекомендуется использовать FileDatasetFactory.upload_directory.

upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)

Параметры

files
list[str]
Обязательно

Список абсолютных путей к отправляемым файлам.

relative_root
str, <xref:optional>
Обязательно

Базовый путь, используемый для определения пути к файлам в общей папке. Например, в случае передачи файла /path/to/file.txt и определения базового пути /path, при отправке файла file.txt в общую папку у него будет путь /to/file.txt. Если также указан target_path, он будет использоваться как префикс для производного пути выше. Базовый путь должен представлять собой общий путь ко всем файлам, в противном случае вызывается исключение. Значение по умолчанию — None (общий путь находится автоматически).

target_path
str, <xref:optional>
Обязательно

Расположение в общей папке для отправки данных. Значение по умолчанию — None, корень.

overwrite
bool, <xref:optional>
Обязательно

Указывает, следует ли перезаписывать существующие файлы.

show_progress
bool, <xref:optional>
Обязательно

Указывает, демонстрировать ли в консоли ход отправки.

Возвращаемое значение

Экземпляр DataReference целевого пути, по которому выполнялась отправка.

Возвращаемый тип