Skip to content

Commit

Permalink
remove tutorial references to old version_suffix field
Browse files Browse the repository at this point in the history
  • Loading branch information
JoanneBogart committed Sep 27, 2024
1 parent fab0e7e commit 2d9640d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/tutorial_notebooks/datasets_deeper_look.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
"\n",
"The files and directories of registered datasets are stored under a path relative to the root directory (`root_dir`), which, by default, is a shared space at NERSC.\n",
"\n",
"By default, the `relative_path` is constructed from the `name`, `version` and `version_suffix` (if there is one), in the format `relative_path=<name>/<version>_<version_suffix>`. However, one can also manually select the relative_path during registration, for example"
"By default, the `relative_path` is constructed from the `name` and `version`, in the format `relative_path=<name>/<version>. However, one can also manually select the relative_path during registration, for example"
]
},
{
Expand Down
8 changes: 4 additions & 4 deletions docs/source/tutorial_notebooks/register_datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,13 @@
"\n",
"### The dataset name (mandatory)\n",
"\n",
"The first of two mandatory arguments to the `register()` function is the dataset `name`, which in our example is `nersc_tutorial:my_first_desc_dataset` (note there is nothing special about the \":\" here, the name can be any legal string). This should be any convenient, evocative name for the human, however note that the special characters `&*/\\?$` and spaces are not allowed to be part of the `name` string. The combination of `name`, `version`, `version_suffix`, `owner` and `owner_type` for any dataset must be unique in the database.\n",
"The first of two mandatory arguments to the `register()` function is the dataset `name`, which in our example is `nersc_tutorial:my_first_desc_dataset` (note there is nothing special about the \":\" here, the name can be any legal string). This should be any convenient, evocative name for the human, however note that the special characters `&*/\\?$` and spaces are not allowed to be part of the `name` string. The combination of `name`, `version`, `owner` and `owner_type` for any dataset must be unique in the database.\n",
"\n",
"The dataset `name` allows for an easy retrieval of the dataset for querying and updating.\n",
"\n",
"### The version string (mandatory)\n",
"\n",
"The second required parameter is the version string, in the semantic format, i.e., MAJOR.MINOR.PATCH. There exists also an optional ``version_suffix`` parameter, which may be used to further identify the dataset, e.g. with a value like \"rc1\" to make it clear it's only a release candidate, possibly not in its final form.\n",
"The second required parameter is the version string, in the semantic format, i.e., MAJOR.MINOR.PATCH. \n",
"\n",
"\n",
"### Owner and Owner type\n",
Expand Down Expand Up @@ -294,7 +294,7 @@
"\n",
"If you have a dataset that has been previously registered within the data registry, and that dataset has updates, it is simple to register the updated version.\n",
"\n",
"Register the new dataset using the same process as before, making sure to keep the same dataset `name`, but updating the dataset `version` (and/or `version_suffix`). One can update the version in two ways: (1) manually entering a new version string, or (2) having the dataregistry automatically \"bump\" the dataset version by selecing either \"major\", \"minor\" or \"patch\" for the version string. For example, let's register an updated version of our dataset, bumping the minor tag (i.e., bumping 1.0.0 -> 1.1.0)."
"Register the new dataset using the same process as before, making sure to keep the same dataset `name`, but updating the dataset `version`. One can update the version in two ways: (1) manually entering a new version string, or (2) having the dataregistry automatically \"bump\" the dataset version by selecing either \"major\", \"minor\" or \"patch\" for the version string. For example, let's register an updated version of our dataset, bumping the minor tag (i.e., bumping 1.0.0 -> 1.1.0)."
]
},
{
Expand Down Expand Up @@ -340,7 +340,7 @@
"\n",
"Rather than updating a dataset to a newer verison, one can also replace a dataset using the `replace()` method of the `Registrar` class. \n",
"\n",
"Replace functionally is very similar to the registration process for a new entry. The difference is that `replace()` will first delete any previous data files associated with the dataset, then register a new entry, keeping the same `name`, `version`, `version_suffix` and `relative_path` as before. This requires that the dataset you are overwriting was registered with `is_overwritable=True`.\n",
"Replace functionally is very similar to the registration process for a new entry. The difference is that `replace()` will first delete any previous data files associated with the dataset, then register a new entry, keeping the same `name`, `version` and `relative_path` as before. This requires that the dataset you are overwriting was registered with `is_overwritable=True`.\n",
"\n",
"Note that whilst the data in the shared space will be overwritten, the original entries in the data registry database are never lost (a new unique entry is created each time, and the 'old' entries will obtain a `replaced` bit in their `status`, and additionally point to the dataset that overwrote them in the `replace_id` column). \n",
"\n",
Expand Down

0 comments on commit 2d9640d

Please sign in to comment.