Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
dcherian committed Feb 20, 2025
1 parent e75a8e0 commit d58846c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
5 changes: 2 additions & 3 deletions docs/docs/concepts/concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,8 @@ They overlap writes on the chunk spanning the range `10:20`.
In this case, only one commit will succeed, and the other will raise an error.
_This is good!_ It means Icechunk helped us avoid a potentially inconsistent update to the array
that would have produced an incorrect end state.
:::tip
This sort of consistency problem is not possible to detect when using Zarr directly on object storage.
:::
!!! tip
This sort of consistency problem is not possible to detect when using Zarr directly on object storage.

It is now up to the user to decide what to do next.
In the example below, the user's code implements a manual retry by checking out the repo in its
Expand Down
7 changes: 3 additions & 4 deletions docs/docs/concepts/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,8 @@ In standard Zarr usage, these keys are filenames in a filesystem or object keys

When writing data, a Zarr implementation will create these keys and populate them with data.

:::tip
An important point is that **the state of a Zarr dataset is spread over many different keys**, both metadata and chunks.
:::
!!! tip
An important point is that **the state of a Zarr dataset is spread over many different keys**, both metadata and chunks.

## Icechunk Data Model

Expand Down Expand Up @@ -80,7 +79,7 @@ Tags are appropriate for publishing specific releases of a repository or for any

Chunk references are "pointers" to chunks that exist in other files--HDF5, NetCDF, GRIB, etc.
Icechunk can store these references alongside native Zarr chunks as "virtual datasets".
You can then can update these virtual datasets incrementally (overwrite chunks, change metadata, etc.) without touching the underlying files.
You can then can update these virtual datasets incrementally (overwrite chunks, change metadata, etc.) without touching the underlying files.
Chunk references are stored in "chunk manifest" files.

### How Does It Work?
Expand Down
11 changes: 5 additions & 6 deletions docs/docs/concepts/version-control-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,8 @@ graph TD;
I-->|retry| D
```

:::caution
The "optimistic concurrency" approach is relatively expensive and assumes that conflicts
are unlikely. It makes the assumption that users will design their workloads to avoid
deliberately creating many simultaneous commits at the same time.
This is elaborated further in [Best Practices](best-practices).
:::
!!! caution
The "optimistic concurrency" approach is relatively expensive and assumes that conflicts
are unlikely. It makes the assumption that users will design their workloads to avoid
deliberately creating many simultaneous commits at the same time.
This is elaborated further in [Best Practices](best-practices).

0 comments on commit d58846c

Please sign in to comment.