Skip to content

Commit

Permalink
Added some basic documentation for local filesystem mode.
Browse files Browse the repository at this point in the history
  • Loading branch information
andreidenissov-cog committed Jan 31, 2020
1 parent cf4d9e8 commit 0291be0
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/local_filesystem_setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Setting up experiment storage and database in local filesystem
==============================================================

This page describes how to setup studioml to use
local filesystem for storing experiment artifacts and meta-data.
With this option, there is no need to setup any external
connection to S3/Minio/GCS etc.

StudioML configuration
--------------------

::

"studio_ml_config": {

...

"database": {
"type": "local",
"endpoint": SOME_DB_LOCAL_PATH,
"bucket": DB_BUCKET_NAME,
"authentication": "none"
},
"storage": {
"type": "local",
"endpoint": SOME_ARTIFACTS_LOCAL_PATH,
"bucket": ARTIFACTS_BUCKET_NAME,
}

...
}


With StudioML database type set to "local",
all experiment meta-data will be stored locally under
directory: SOME_DB_LOCAL_PATH/DB_BUCKET_NAME.
Similarly, with storage type set to "local",
all experiment artifacts will be stored locally under
directory: SOME_ARTIFACTS_LOCAL_PATH/ARTIFACTS_BUCKET_NAME.

Note: if you are using "local" mode, it is recommended to use it
for both storage and database configuration.
But it's technically possible to mix, for example, local storage configuration
and S3-based database configuration etc.

0 comments on commit 0291be0

Please sign in to comment.