docs/index.html at main · MAGNET4Cardiac7T/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>magnet-pinn documentation &mdash; magnet-pinn 0.0.4 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
      <link rel="stylesheet" type="text/css" href="_static/dynabench.css?v=56ba74db" />


  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->

        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=8c5712d9"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
        <script src="_static/design-tabs.js?v=36754332"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="About the MAGNET4Cardiac7T project" href="about.html" />
</head>

<body class="wy-body-for-nav">
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >


          <a href="#" class="icon icon-home">
            magnet-pinn
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="start.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="papers.html">Paper List</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API reference</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">magnet-pinn</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">magnet-pinn documentation</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">

  <section id="magnet-pinn-documentation">
<h1>magnet-pinn documentation<a class="headerlink" href="#magnet-pinn-documentation" title="Link to this heading"></a></h1>
<p><strong>Date</strong>: Nov 21, 2024 <strong>Version</strong>: 0.0.4</p>
<p><strong>Useful links</strong>:
<a class="reference external" href="start">Install</a> |
<a class="reference external" href="https://github.com/MAGNET4Cardiac7T/magnet-pinn">Source Repository</a> |
<a class="reference external" href="https://github.com/MAGNET4Cardiac7T/magnet-pinn">Dataset</a> |</p>
<p><strong>magnet-pinn</strong> is an open-source package for developing, training and evaluating deep learning models for predicting EM-Fields inside a MRI scanner.
It is built on top of PyTorch and provides a simple and flexible API for training and evaluating models. The package includes a dataset class for loading simulated EM-FIleds, a data iterator for training models, and a set of pre-trained models.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-2 sd-g-xs-2 sd-g-sm-3 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/book-solid.svg" />
<div class="sd-card-header docutils">
<p class="sd-card-text"><strong>Getting Started</strong></p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">The Getting Started guide will help you get started with magnet-pinn.
It shows how to download the data use our data iterator.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary sd-stretched-link reference internal" href="start.html"><span class="doc">To the guide</span></a></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/wrench-solid.svg" />
<div class="sd-card-header docutils">
<p class="sd-card-text"><strong>API reference</strong></p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">The reference guide contains a description of the magnet-pinn package.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary sd-stretched-link reference internal" href="api.html"><span class="doc">To the API reference</span></a></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/chart-line-solid.svg" />
<div class="sd-card-header docutils">
<p class="sd-card-text"><strong>Benchmark results</strong></p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">The benchmark results show the performance of different models for the task of predicting EM Fields.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary sd-stretched-link reference internal" href="results.html"><span class="doc">To the results</span></a></p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-text-center docutils">
<img alt="" class="sd-card-img-top" src="_images/file-lines-solid.svg" />
<div class="sd-card-header docutils">
<p class="sd-card-text"><strong>Paper List</strong></p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">This is a list of papers related to the MAGNET4Cardiac7T Project.</p>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary sd-stretched-link reference internal" href="papers.html"><span class="doc">To the paper</span></a></p>
</div>
</div>
</div>
</div>
</div>
<div class="toctree-wrapper compound">
</div>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="about.html" class="btn btn-neutral float-right" title="About the MAGNET4Cardiac7T project" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2024, Andrzej Dulny.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

</body>
</html>