Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: ♻️ Refactor layout docs #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2023
Merged

docs: ♻️ Refactor layout docs #582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 59 additions & 57 deletions docs/plugins/pkl-converter_visualization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,26 +83,26 @@ dict_4 --> dict_4.pkl

!!! info "Using the `spectrafit-pkl-converter` as a Python module"

In the case of using `spectrafit-pkl-converter` as a Python module, the
following:
In the case of using `spectrafit-pkl-converter` as a Python module, the
following:

```python
from spectrafit.plugins.pkl_converter import PklConverter
```python
from spectrafit.plugins.pkl_converter import PklConverter

pkl_converter = PklConverter()
list_dict = pkl_converter.convert_pkl_to_csv(
infile="test.pkl",
)
```
pkl_converter = PklConverter()
list_dict = pkl_converter.convert_pkl_to_csv(
infile="test.pkl",
)
```

The `list_dict` variable contains the converted data as a list of
dictionaries.

See also:
See also:

::: spectrafit.plugins.pkl_converter.PklConverter
:members:
:undoc-members:
::: spectrafit.plugins.pkl_converter.PklConverter
:members:
:undoc-members:

## PKL Visualizer

Expand Down Expand Up @@ -135,52 +135,54 @@ structure of the JSON file:

??? example "Example of the JSON file"

```json
{
"file_1": {
"attribute_1": "<class 'list'>",
"attribute_2": "<class 'str'>",
"attribute_3": "<class 'numpy.ndarray'> of shape (201,)",
"attribute_4": "<class 'numpy.ndarray'> of shape (199,)",
"attribute_5": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_6": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_7": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_8": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_9": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_10": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_11": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_12": "<class 'numpy.ndarray'> of shape (10000,)",
"attribute_13": "<class 'list'>",
"attribute_14": "<class 'numpy.ndarray'> of shape (10, 201)",
"attribute_16": "<class 'int'>",
"attribute_17": "<class 'str'>",
"attribute_19": "<class 'str'>"
},
"file_2": {
"attribute_1": "<class 'list'>",
"attribute_2": "<class 'str'>",
"attribute_3": "<class 'numpy.ndarray'> of shape (201,)",
"attribute_4": "<class 'numpy.ndarray'> of shape (199,)",
"attribute_5": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_6": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_7": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_8": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_9": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_10": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_11": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_12": "<class 'numpy.ndarray'> of shape (10000,)",
"attribute_13": "<class 'list'>",
"attribute_14": "<class 'numpy.ndarray'> of shape (10, 201)",
"attribute_16": "<class 'int'>",
"attribute_17": "<class 'str'>",
"attribute_19": "<class 'str'>"
}
}
```
```json
{
"file_1": {
"attribute_1": "<class 'list'>",
"attribute_2": "<class 'str'>",
"attribute_3": "<class 'numpy.ndarray'> of shape (201,)",
"attribute_4": "<class 'numpy.ndarray'> of shape (199,)",
"attribute_5": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_6": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_7": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_8": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_9": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_10": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_11": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_12": "<class 'numpy.ndarray'> of shape (10000,)",
"attribute_13": "<class 'list'>",
"attribute_14": "<class 'numpy.ndarray'> of shape (10, 201)",
"attribute_16": "<class 'int'>",
"attribute_17": "<class 'str'>",
"attribute_19": "<class 'str'>"
},
"file_2": {
"attribute_1": "<class 'list'>",
"attribute_2": "<class 'str'>",
"attribute_3": "<class 'numpy.ndarray'> of shape (201,)",
"attribute_4": "<class 'numpy.ndarray'> of shape (199,)",
"attribute_5": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_6": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_7": "<class 'numpy.ndarray'> of shape (10, 201, 10000)",
"attribute_8": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_9": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_10": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_11": "<class 'numpy.ndarray'> of shape (10, 199, 10000)",
"attribute_12": "<class 'numpy.ndarray'> of shape (10000,)",
"attribute_13": "<class 'list'>",
"attribute_14": "<class 'numpy.ndarray'> of shape (10, 201)",
"attribute_16": "<class 'int'>",
"attribute_17": "<class 'str'>",
"attribute_19": "<class 'str'>"
}
}
```

!!! info "Example of the graph"

The resulting graph looks like this:
The resulting graph looks like this:

![_](images/pkl_visualizer.png)
![_](images/pkl_visualizer.png)

[1]: http
[1]: https://docs.python.org/3/library/pickle.html
Expand Down