Skip to content

Commit

Permalink
guide: add hash field (#4735)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave Berenbaum authored Jul 31, 2023
1 parent dbc446e commit 7e8f35a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions content/docs/user-guide/project-structure/dvc-files.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The following subfields may be present under `outs` entries:
| Field | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path` | (Required) Path to the file or directory (relative to `wdir` which defaults to the file's location) |
| `hash` | Hash algorithm for the file or directory being tracked with DVC (only `md5` is currently supported). |
| `md5`<br/>`etag`<br/>`checksum` | Hash value for the file or directory being tracked with DVC. MD5 is used for most locations (local file system and SSH); [ETag] for HTTP, S3, or Azure [external outputs]; and a special _checksum_ for HDFS and WebHDFS. |
| `version_id` | Version ID native to the cloud provider. Used to track each file in the cloud if [cloud versioning] is enabled. |
| `size` | Size of the file or directory (sum of all files) |
Expand All @@ -68,6 +69,7 @@ The following subfields may be present under `deps` entries:
| Field | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `path` | (Required) Path to the dependency (relative to `wdir`, which defaults to the file's location) |
| `hash` | Hash algorithm for the file or directory being tracked with DVC (only `md5` is currently supported). |
| `md5`<br/>`etag`<br/>`checksum` | Only in <abbr>external dependencies</abbr> created with `dvc import-url`: Hash value of the imported file or directory. MD5 is used for local paths and SSH; [ETag] for HTTP, S3, GCS, and Azure; and a special _checksum_ for HDFS and WebHDFS. |
| `size` | Size of the file or directory (sum of all files). |
| `nfiles` | If this dependency is a directory, the number of files inside (recursive). |
Expand Down

0 comments on commit 7e8f35a

Please sign in to comment.