Skip to content

Commit 7e4e03a

Browse files
alex-aizmanalex-aizman
committed
docs: more pre-release edits
Signed-off-by: Alex Aizman <[email protected]>
1 parent 84d11a3 commit 7e4e03a

File tree

3 files changed

+30
-21
lines changed

3 files changed

+30
-21
lines changed

‎docs/changelog/v3.24.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -786,7 +786,7 @@ Version 3.24 arrives nearly 4 months after the previous one and contains more th
786786
| - github-CI python
787787
| - tests: skip ec-destroy-bucket
788788
| - fs-path-error: empty path is now treated as not
789-
* "user-friendly "d[id you mean" message" d015ea5e6](https://github.com/NVIDIA/aistore/commit/id)
789+
* "user-friendly "did you mean" message" [d015ea5e6](https://github.com/NVIDIA/aistore/commit/d015ea5e6)
790790
| * erroneous 'ais show gs://abc[/object]' will now produce the right hint
791791
| * up cli
792792
* "fix rendering issues for EC xactions output" [94578e9f0](https://github.com/NVIDIA/aistore/commit/94578e9f0)
@@ -842,7 +842,7 @@ Version 3.24 arrives nearly 4 months after the previous one and contains more th
842842
| * do not build disk metric names at runtime
843843
| * CLI: skip internal (`lcache`, `stream`) counters unless verbose
844844
| * CLI: version check vs. nodes in maintenance
845-
* "support per-backend cumulative ("t[otal") latencies" 988051c28](https://github.com/NVIDIA/aistore/commit/otal)
845+
* "support per-backend cumulative ["total" latencies](https://github.com/NVIDIA/aistore/commit/988051c28)
846846
| * revise 'ais performance latency'
847847
| * use `.total.` latencies and their respective counters
848848
| * related commit: 5fd101589c7

‎docs/cli/bucket.md‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -183,13 +183,15 @@ NAME:
183183
* ais ls s3 - list all s3 buckets that are present in the cluster;
184184
* ais ls s3 --all - list all s3 buckets, both present and remote;
185185
with template, regex, and/or prefix:
186-
* ais ls gs: --regex "^abc" --all - list all accessible GCP buckets with names starting with "abc";
187-
* ais ls ais://abc --regex ".md" --props size,checksum - list *.md objects with their respective sizes and checksums;
188-
* ais ls gs://abc --template images/ - list all objects from the virtual subdirectory called "images";
189-
* ais ls gs://abc --prefix images/ - same as above (for more examples, see '--template' below);
186+
* ais ls gs: --regex "^abc" --all - list all accessible GCP buckets with names starting with "abc";
187+
* ais ls ais://abc --regex ".md" --props size,checksum - list *.md objects with their respective sizes and checksums;
188+
* ais ls gs://abc --template images/ - list all objects from the virtual subdirectory called "images";
189+
* ais ls gs://abc --prefix images/ - same as above (for more examples, see '--template' below);
190+
* ais ls gs://abc/images/ - same as above.
190191
and summary (stats):
191-
* ais ls s3 --summary - for each s3 bucket in the cluster: print object numbers and total size(s);
192-
* ais ls s3 --summary --all - generate summary report for all s3 buckets; include remote objects and buckets that are _not present_
192+
* ais ls s3 --summary - for each s3 bucket in the cluster: print object numbers and total size(s);
193+
* ais ls s3 --summary --all - generate summary report for all s3 buckets; include remote objects and buckets that are _not present_;
194+
* ais ls s3 --summary --all --dont-add - same as above but without adding _non-present_ remote buckets to cluster's BMD.
193195
```
194196

195197
## Assorted options
@@ -274,19 +276,20 @@ NAME:
274276
* ais ls s3 - list all s3 buckets that are present in the cluster;
275277
* ais ls s3 --all - list all s3 buckets, both in-cluster and remote;
276278
with template, regex, and/or prefix:
277-
* ais ls gs: --regex "^abc" --all - list all accessible GCP buckets with names starting with "abc";
278-
* ais ls ais://abc --regex ".md" --props size,checksum - list *.md objects with their respective sizes and checksums;
279-
* ais ls gs://abc --template images/ - list all objects from the virtual subdirectory called "images";
280-
* ais ls gs://abc --prefix images/ - same as above (for more examples, see '--template' below);
279+
* ais ls gs: --regex "^abc" --all - list all accessible GCP buckets with names starting with "abc";
280+
* ais ls ais://abc --regex ".md" --props size,checksum - list *.md objects with their respective sizes and checksums;
281+
* ais ls gs://abc --template images/ - list all objects from the virtual subdirectory called "images";
282+
* ais ls gs://abc --prefix images/ - same as above (for more examples, see '--template' below);
283+
* ais ls gs://abc/images/ - same as above.
281284
with in-cluster vs remote content comparison (diff):
282285
* ais ls s3://abc --check-versions - for each remote object in s3://abc: check whether it has identical in-cluster copy
283-
and show missing objects
286+
and show missing objects;
284287
* ais ls s3://abc --check-versions --cached - for each in-cluster object in s3://abc: check whether it has identical remote copy
285-
and show deleted objects
288+
and show deleted objects.
286289
with summary (stats):
287290
* ais ls s3 --summary - for each s3 bucket in the cluster: print object numbers and total size(s);
288-
* ais ls s3 --summary --all - generate summary report for all s3 buckets; include remote objects and buckets that are _not present_
289-
* ais ls s3 --summary --all --dont-add - same as above but without adding _non-present_ remote buckets to cluster's BMD
291+
* ais ls s3 --summary --all - generate summary report for all s3 buckets; include remote objects and buckets that are _not present_;
292+
* ais ls s3 --summary --all --dont-add - same as above but without adding _non-present_ remote buckets to cluster's BMD.
290293

291294
USAGE:
292295
ais ls [command options] PROVIDER:[//BUCKET_NAME]

‎docs/howto_virt_dirs.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Unlike hierarchical POSIX, object storage is flat, treating forward slash ('/') in object names as simply another symbol.
44

5-
But that's not the entire truth. The other part of it is that user may want to operate (list, train, copy, transform, etc.)
6-
on a subset of objects in a dataset that, for the lack of better word, looks _exactly_ like a directory.
5+
But that's not the entire truth. The other part of it is that user may want to operate on (ie., list, load, shuffle, copy, transform, etc.)
6+
subset of objects in a dataset that, for the lack of better word, looks _exactly_ like a directory.
77

88
In fact, user often wants to do exactly that.
99
Train, for instance, on all audio files under `en_es_synthetic/v1/train/`, or similar.
@@ -27,7 +27,7 @@ Needless to say, aistore provides for all of that and more. There is a certainty
2727

2828
## Examples
2929

30-
### Show everything that has a certain prefix
30+
### 1. Show everything that has a certain prefix
3131

3232
```console
3333
$ ais ls s3://speech --prefix .inventory
@@ -41,7 +41,13 @@ NAME SIZE
4141
.inventory/speech/hive/dt=2024-05-31-01-00/symlink.txt 85B no
4242
```
4343

44-
### Same as above, without directories
44+
### 2. Same as above using familiar `*nix` notation
45+
46+
```console
47+
$ ais ls s3://speech/.inventory
48+
```
49+
50+
### 3. Same as above, without directories
4551

4652
```console
4753
$ ais ls s3://speech --prefix .inventory --no-dirs
@@ -54,7 +60,7 @@ NAME SIZE
5460
.inventory/speech/hive/dt=2024-05-31-01-00/symlink.txt 85B no
5561
```
5662

57-
### Show dataset structure at a certain nested depth
63+
### 4. Show dataset structure at a certain nested depth
5864

5965
```console
6066
$ ais ls s3://speech --prefix .inventory/speech/ --nr

0 commit comments

Comments
 (0)