Skip to content

Document Azure blob storage option #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rosscutler wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document Azure blob storage option #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ If you use this tool in your research please cite it with the following referenc
* [Preparation](docs/preparation.md)
* [Running the Test on Amazon Mechanical Turk](docs/running_test_mturk.md)
* [Analyzing Data](docs/results.md)
* [Azure Blob Storage Support](docs/azure_support.md)

By default the scripts expect CSV files listing the clip URLs. When the optional
Azure configuration is provided and the CSV arguments are omitted, the toolkit
will download clip lists from an Azure Blob Storage container.


## News
Expand Down
31 changes: 31 additions & 0 deletions docs/azure_support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[Home](../README.md) > Azure Blob Storage Support
# Azure Blob Storage Support

The toolkit normally expects CSV files that list the URLs to all audio clips used in a test. When a CSV file is supplied via the command line, it will be used as the data source.

Alternatively, the toolkit can read audio clips directly from an Azure Blob Storage container. To enable this, provide the storage details in the configuration file and omit the CSV arguments.

## Configuration example
```ini
[CommonAccountKeys]
# Storage account access key
mystorageaccount:

[DefaultStorage]
StorageUrl:https://mystorageaccount.blob.core.windows.net
StorageAccountKey:${CommonAccountKeys:mystorageaccount}
Container:p808-assets
Path:/clips/rating/

[RatingClips]
RatingClipsConfigurations:store1

[store1]
StorageUrl:${DefaultStorage:StorageUrl}
StorageAccountKey:${DefaultStorage:StorageAccountKey}
Container:${DefaultStorage:Container}
Path:${DefaultStorage:Path}
```

When the above sections are present and `--clips`, `--gold_clips` and `--trapping_clips` are not supplied, the scripts will query Azure to obtain the list of clips. Using CSV files remains the default approach and requires no Azure configuration.

9 changes: 6 additions & 3 deletions docs/preparation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,18 @@ The following steps should be performed to prepare the test setup.
cd P.808
```

1. Install the python module dependencies in `requirements.txt` using `pip`
1. Install the python module dependencies in `requirements.txt` using `pip`

```bash
cd src
pip install -r requirements.txt
```

1. (optional) Upload the general resources (found in `src\P809Template\assets`) in a cloud server and change the
URLs associated to them as described in [General Resources](general_res.md)
1. (optional) Upload the general resources (found in `src\P809Template\assets`) in a cloud server and change the
URLs associated to them as described in [General Resources](general_res.md)

1. (optional) If you want to store clips in Azure Blob Storage instead of using CSV files,
configure the storage details as shown in [Azure Blob Storage Support](azure_support.md).

1. Follow the rest of preparation process based on the test methodology you want to apply:

Expand Down