docs: add cloud storage access documentation#567
Open
haoyu-haoyu wants to merge 2 commits intoMIT-LCP:mainfrom
Open
docs: add cloud storage access documentation#567haoyu-haoyu wants to merge 2 commits intoMIT-LCP:mainfrom
haoyu-haoyu wants to merge 2 commits intoMIT-LCP:mainfrom
Conversation
Document the fsspec-based cloud/remote file access feature that was added in PR MIT-LCP#523 but never documented. Covers: - Supported protocols (S3, GCS, Azure, HTTPS) - Installation of cloud extras - Usage examples for rdrecord and rdann with remote paths - Authentication guidance for credentialed cloud providers Closes MIT-LCP#547
- Narrow supported protocols to s3://, gs://, az://, azureml:// (matching actual code in _coreio.py) - Remove non-existent wfdb[cloud] install extra — fsspec is already a core dependency; document per-provider backend packages instead - Fix examples: cloud URIs go in record_name, not pn_dir - Remove storage_options reference (not in public API) - Add note clarifying pn_dir vs record_name semantics
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the
fsspec-based cloud storage access feature (added in PR #523) which was never documented.Content
New "Cloud Storage Access" section in
docs/io.rstcovering:s3://,gs://,az://,azureml://s3fs,gcsfs,adlfs)rdrecordandrdannrecord_name, notpn_dirCloses #547