Skip to content

Commit 0291be0

Browse files
Added some basic documentation for local filesystem mode.
1 parent cf4d9e8 commit 0291be0

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/local_filesystem_setup.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Setting up experiment storage and database in local filesystem
2+
==============================================================
3+
4+
This page describes how to setup studioml to use
5+
local filesystem for storing experiment artifacts and meta-data.
6+
With this option, there is no need to setup any external
7+
connection to S3/Minio/GCS etc.
8+
9+
StudioML configuration
10+
--------------------
11+
12+
::
13+
14+
"studio_ml_config": {
15+
16+
...
17+
18+
"database": {
19+
"type": "local",
20+
"endpoint": SOME_DB_LOCAL_PATH,
21+
"bucket": DB_BUCKET_NAME,
22+
"authentication": "none"
23+
},
24+
"storage": {
25+
"type": "local",
26+
"endpoint": SOME_ARTIFACTS_LOCAL_PATH,
27+
"bucket": ARTIFACTS_BUCKET_NAME,
28+
}
29+
30+
...
31+
}
32+
33+
34+
With StudioML database type set to "local",
35+
all experiment meta-data will be stored locally under
36+
directory: SOME_DB_LOCAL_PATH/DB_BUCKET_NAME.
37+
Similarly, with storage type set to "local",
38+
all experiment artifacts will be stored locally under
39+
directory: SOME_ARTIFACTS_LOCAL_PATH/ARTIFACTS_BUCKET_NAME.
40+
41+
Note: if you are using "local" mode, it is recommended to use it
42+
for both storage and database configuration.
43+
But it's technically possible to mix, for example, local storage configuration
44+
and S3-based database configuration etc.
45+

0 commit comments

Comments
 (0)