Skip to content

Commit 7d9357b

Browse files
committed
docs: handle joblib in getting_started
1 parent 972a161 commit 7d9357b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/getting_started.Rmd

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,9 @@ While we’ll do our best to keep the automatically generated metadata consisten
130130
## 🚧 Versioning
131131

132132

133+
> ⚠️: Warning the examples in this section use joblib to read and write data. Joblib uses the pickle format, and **pickle files are not secure**. Only read pickle files you trust. In order to read pickle files, set the `allow_pickle_read=True` argument. See: https://docs.python.org/3/library/pickle.html.
134+
135+
133136
> ⚠️: versioning is not yet implemented. These docs are copied from R pins.
134137
135138
In many situations it's useful to version pins, so that writing to an existing pin does not replace the existing data, but instead adds a new copy.
@@ -154,9 +157,8 @@ The primary exception is `board_folder()` since that stores data on your compute
154157
Once you have turned versioning on, every `pin_write()` will create a new version:
155158

156159
```{python}
157-
# TODO: can save lists using joblib, but should warn about security
160+
board2 = board_temp(versioned = True, allow_pickle_read=True)
158161

159-
board2 = board_temp(versioned = True)
160162
board2.pin_write([1,2,3,4,5], name = "x", type = "joblib", title="TODO")
161163
board2.pin_write([1,2,3], name = "x", type = "joblib", title="TODO")
162164
board2.pin_write([1,2], name = "x", type = "joblib", title="TODO")

0 commit comments

Comments
 (0)