Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Z
zema_emc_annotated
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
M4D
zema_emc_annotated
Commits
e06e7938
Verified
Commit
e06e7938
authored
2 years ago
by
Björn Ludwig
Browse files
Options
Downloads
Patches
Plain Diff
docs(dataset): improve docstring of ZeMASamples
parent
0fda88e4
No related branches found
No related tags found
No related merge requests found
Pipeline
#16358
failed
2 years ago
Stage: test
Stage: deploy
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/conf.py
+1
-0
1 addition, 0 deletions
docs/conf.py
src/zema_emc_annotated/dataset.py
+7
-0
7 additions, 0 deletions
src/zema_emc_annotated/dataset.py
with
8 additions
and
0 deletions
docs/conf.py
+
1
−
0
View file @
e06e7938
...
...
@@ -53,6 +53,7 @@ html_theme_options = {
intersphinx_mapping
=
{
"
np
"
:
(
"
https://numpy.org/doc/stable/
"
,
None
),
"
Python
"
:
(
"
https://docs.python.org/3
"
,
None
),
"
pooch
"
:
(
"
https://www.fatiando.org/pooch/latest/
"
,
None
),
}
# We keep the objects.inv files in our docs folder to get hints on how to specify the
# cross-references. More on the topic can be found here:
...
...
This diff is collapsed.
Click to expand it.
src/zema_emc_annotated/dataset.py
+
7
−
0
View file @
e06e7938
...
...
@@ -65,6 +65,13 @@ class ZeMASamples:
The underlying dataset is the annotated
"
Sensor data set of one electromechanical
cylinder at ZeMA testbed (ZeMA DAQ and Smart-Up Unit)
"
by Dorst et al. [Dorst2021]_.
Each extracted sample will be cached in the download directory of the file,
which is handled by :func:`pooch.os_cache`, where ``<AppName>`` evaluates to
``pooch``. That way the concurrent retrieval of the same data is as performant as
possible and can simply be left to ``zema_emc_annotated``. Where ever the result
of ``ZeMASamples`` is needed in an external code base, it should be safe to call
it over and over without causing unnecessary extractions or even downloads. The
underlying mechanism is Python
'
s built-in ``pickle``.
Parameters
----------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment