Skip to content

Commit fa70fc7

Browse files
Add volume mounting to release notes
1 parent 1dcc36b commit fa70fc7

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

docs/release-notes/v0.7.0.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Important Notes
1414
* A ``pyhf.default_backend`` has been added that is configurable through a
1515
``default`` kwarg in :func:`pyhf.set_backend`.
1616
(PR :pr:`1646`)
17+
* :class:`pyhf.readxml` now supports reading of XML configurations with absolute paths.
18+
To support this, ``pyhf xlm2json`` now has ``-v/--mount`` options.
19+
(PR :pr:`1909`)
1720
* Performance in :class:`pyhf.readxml` is increased by improvements to
1821
:func:`pyhf.readxml.import_root_histogram`.
1922
(PR :pr:`1691`)
@@ -93,8 +96,8 @@ Python API
9396
>>> jax.jacrev(jax.jit(example_op))([2.0])
9497
[DeviceArray([24.], dtype=float64, weak_type=True)]
9598
96-
* A ``validate`` kwarg has been added to :func:`pyhf.workspace.Workspace` to allow
97-
skipping validation.
99+
* A ``validate`` kwarg has been added to :func:`pyhf.workspace.Workspace` and
100+
:func:`pyhf.pdf.Model` to allow skipping validation.
98101
(PR :pr:`1646`)
99102
This should only be used by expert users who understand the risks.
100103

@@ -106,6 +109,29 @@ Python API
106109
- :func:`pyhf.tensorlib.percentile`
107110
(PR :pr:`817`)
108111

112+
* :class:`pyhf.readxml` now supports reading of XML configurations with absolute paths.
113+
(PR :pr:`1909`)
114+
115+
CLI API
116+
~~~~~~~
117+
118+
* The ``pyhf xlm2json`` CLI API now has a ``-v/--mount`` option to support reading
119+
XML configurations with absolute paths.
120+
(PR :pr:`1909`)
121+
Similar to Docker volume mounts, the options allows a user to pass two fields
122+
separated by a colon (``:``).
123+
The first field is a local path and the second field is the absolute path specified
124+
in the XML configuration to be substituted.
125+
Without the ``-v/--mount`` option a user would have to manually edit the absolute
126+
path in each XML file it appeared in!
127+
128+
.. code:: console
129+
130+
pyhf xml2json \
131+
--mount /local/path/to/workspace:/absolute/path/to/replace/inside/xml \
132+
--output-file workspace.json \
133+
workspace/analysis_config.xml
134+
109135
Deprecations
110136
------------
111137

src/pyhf/cli/rootio.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def cli():
2727
@click.option(
2828
'-v',
2929
'--mount',
30-
help='Consists of two fields, separated by a colon character ( : ). The first field is the local path to where files are located, the second field is the path where the file or directory are saved in the XML configuration. This is similar in spirit to docker.',
30+
help='Consists of two fields, separated by a colon character ( : ). The first field is the local path to where files are located, the second field is the path where the file or directory are saved in the XML configuration. This is similar in spirit to Docker.',
3131
type=VolumeMountPath(exists=True, resolve_path=True, path_type=Path),
3232
default=None,
3333
multiple=True,

0 commit comments

Comments
 (0)