Frequently Asked Questions

How do I sync my notebook and all of its data and models to S3 as a package?

p = quilt3.Package()
p.set_dir(".", ".")
p.push("USR/PKG", message="MSG", registry="s3://BUCKET")

Use a .quiltignore file for more control over which files set_dir() includes.

How does Quilt versioning relate to S3 object versioning?

Quilt packages are one level of abstraction above S3 object versions. Object versions track mutations to a single file, whereas a quilt package references a collection files and assigns this collection a unique version.

It is strongly recommended that you enable object versioning on the S3 buckets that you push Quilt packages to. Object versioning ensures that mutations to every object are tracked, and provides some protection against deletion.

Where are the Quilt 2 packages?

Visit legacy.quiltdata.com and use quilt on PyPI.

Does quilt3 collect anonymous usage statistics?

Yes, to find bugs and prioritize features.

You can disable anonymous usage collection with an environment variable:

$ export QUILT_DISABLE_USAGE_METRICS=true

Or call quilt3.disable_telemetry() to persistently disable anonymous usage statistics.

Can I turn off TQDM progress bars for log files?

Yes:

$ export QUILT_MINIMIZE_STDOUT=true

Catalog Overview stats (objects, packages) seem incorrect or aren't updating

Catalog Packages tab doesn't work

Catalog packages or stats are missing or are not updating

If you recently added the bucket or upgraded the stack, if search volume is high, or if the bucket is under rapid modification, wait a few minutes and try again.

Re-index the bucket

  1. Open the bucket in the Quilt catalog

  2. Click the gear icon (upper right), or navigate to Users and buckets > Buckets and open the bucket in question ‚Äč

  3. Under "Indexing and notifications", click "Re-index and Repair". Optional: if and only if bucket notifications were deleted or are not working, check "Repair S3 notifications".

  4. Wait a few minutes while bucket statistics and packages repopulate

Diagnose issues with ElasticSearch

  1. Go to CloudFormation > Stacks > YourQuiltStack > Resources

  2. Search for "domain"

  3. Click on the link for "Search" under "Physical ID"

  4. You are now under ElasticSearch > Dashboards

  5. Set the time range to include the period before and after when you noticed

    any issues

  6. Screenshot the dashboard stats for your domain

  7. Click into your domain and then navigate to "Cluster health"

  8. Screenshot Summary, Overall Health, and Key Performance Indicator sections

  9. Send screenshots to Quilt support.

  10. It is not recommended that you adjust ElasticSearch via Edit domain, as these

    changes will be lost the next time that you update Quilt

Which version of Quilt are you on?

  1. Go to CloudFormation > Stacks > YourQuiltStack > Outputs

  2. Copy the row labeled TemplateBuildMetadata

  3. "git_revision" is your template version