Skip to content

Commit 19efecc

Browse files
committed
deploy: 436e540
1 parent 9755d34 commit 19efecc

6 files changed

Lines changed: 49 additions & 189 deletions

File tree

_modules/grandchallenge/workstations/models.html

Lines changed: 20 additions & 93 deletions
Large diffs are not rendered by default.

components.html

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -433,53 +433,53 @@ <h3>Navigation</h3>
433433
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Interface kinds that are images:
434434

435435
- Displacement field
436-
- Segmentation
437436
- DICOM Image Set
438-
- Image
437+
- Segmentation
439438
- Heat Map
439+
- Image
440440

441441

442442
Interface kinds that are files:
443443

444+
- CSV file
444445
- Thumbnail jpg
445-
- OBJ file
446+
- BIOM format
447+
- MP4 file
446448
- ZIP file
447-
- CSV file
449+
- OBJ file
450+
- Thumbnail png
448451
- SQREG file
449-
- BIOM format
450452
- PDF file
451453
- Newick tree-format file
452-
- Thumbnail png
453-
- MP4 file
454454

455455

456456
Interface kinds that are json serializable:
457457

458-
- Multiple polygons
459-
- Multiple choice
460-
- Integer
461-
- Distance measurement
462-
- Line
463-
- Polygon
464-
- Bool
465-
- Ellipse
466-
- String
467-
- Anything
468-
- Multiple lines
469-
- Three-point angle
470-
- Multiple angles
471-
- Angle
458+
- Multiple distance measurements
472459
- Multiple points
473460
- Multiple three-point angles
474-
- Multiple ellipses
461+
- Float
462+
- Three-point angle
463+
- Anything
464+
- Multiple lines
465+
- Polygon
466+
- 2D bounding box
475467
- Choice
468+
- Bool
469+
- Ellipse
470+
- Chart
471+
- Integer
472+
- Line
473+
- Distance measurement
476474
- Point
477-
- Float
475+
- String
478476
- Affine transform registration
477+
- Multiple angles
479478
- Multiple 2D bounding boxes
480-
- Multiple distance measurements
481-
- 2D bounding box
482-
- Chart
479+
- Multiple ellipses
480+
- Multiple polygons
481+
- Angle
482+
- Multiple choice
483483

484484

485485
Example JSON file contents for String:

genindex.html

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ <h1 id="index">Index</h1>
5454
| <a href="#R"><strong>R</strong></a>
5555
| <a href="#S"><strong>S</strong></a>
5656
| <a href="#T"><strong>T</strong></a>
57-
| <a href="#U"><strong>U</strong></a>
5857
| <a href="#V"><strong>V</strong></a>
5958
| <a href="#W"><strong>W</strong></a>
6059

@@ -510,8 +509,6 @@ <h2 id="S">S</h2>
510509
<li><a href="reader-studies.html#grandchallenge.reader_studies.models.ReaderStudy.score_for_user">score_for_user() (grandchallenge.reader_studies.models.ReaderStudy method)</a>
511510
</li>
512511
<li><a href="reader-studies.html#grandchallenge.reader_studies.models.ReaderStudy.scores_by_user">scores_by_user (grandchallenge.reader_studies.models.ReaderStudy attribute)</a>
513-
</li>
514-
<li><a href="workstations.html#grandchallenge.workstations.models.Session.service">service (grandchallenge.workstations.models.Session property)</a>
515512
</li>
516513
</ul></td>
517514
<td style="width: 33%; vertical-align: top;"><ul>
@@ -538,12 +535,8 @@ <h2 id="S">S</h2>
538535
<li><a href="workstations.html#grandchallenge.workstations.models.SessionUserObjectPermission.MultipleObjectsReturned">SessionUserObjectPermission.MultipleObjectsReturned</a>
539536
</li>
540537
<li><a href="components.html#grandchallenge.components.models.SourceChoices">SourceChoices (class in grandchallenge.components.models)</a>
541-
</li>
542-
<li><a href="workstations.html#grandchallenge.workstations.models.Session.start">start() (grandchallenge.workstations.models.Session method)</a>
543538
</li>
544539
<li><a href="reader-studies.html#grandchallenge.reader_studies.models.ReaderStudy.statistics">statistics (grandchallenge.reader_studies.models.ReaderStudy attribute)</a>
545-
</li>
546-
<li><a href="workstations.html#grandchallenge.workstations.models.Session.stop">stop() (grandchallenge.workstations.models.Session method)</a>
547540
</li>
548541
<li><a href="reader-studies.html#grandchallenge.reader_studies.models.ReaderStudy.study_image_names">study_image_names (grandchallenge.reader_studies.models.ReaderStudy attribute)</a>
549542
</li>
@@ -566,14 +559,6 @@ <h2 id="T">T</h2>
566559
</ul></td>
567560
</tr></table>
568561

569-
<h2 id="U">U</h2>
570-
<table style="width: 100%" class="indextable genindextable"><tr>
571-
<td style="width: 33%; vertical-align: top;"><ul>
572-
<li><a href="workstations.html#grandchallenge.workstations.models.Session.update_status">update_status() (grandchallenge.workstations.models.Session method)</a>
573-
</li>
574-
</ul></td>
575-
</tr></table>
576-
577562
<h2 id="V">V</h2>
578563
<table style="width: 100%" class="indextable genindextable"><tr>
579564
<td style="width: 33%; vertical-align: top;"><ul>

objects.inv

-27 Bytes
Binary file not shown.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

workstations.html

Lines changed: 2 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,7 @@ <h3>Navigation</h3>
176176
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session">
177177
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">grandchallenge.workstations.models.</span></span><span class="sig-name descname"><span class="pre">Session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grandchallenge/workstations/models.html#Session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grandchallenge.workstations.models.Session" title="Link to this definition"></a></dt>
178178
<dd><p>Tracks who has launched workstation images. The <code class="docutils literal notranslate"><span class="pre">WorkstationImage</span></code> will
179-
be launched as a <code class="docutils literal notranslate"><span class="pre">Service</span></code>. The <code class="docutils literal notranslate"><span class="pre">Session</span></code> is responsible for starting
180-
and stopping the <code class="docutils literal notranslate"><span class="pre">Service</span></code>.</p>
179+
be launched as a <code class="docutils literal notranslate"><span class="pre">ECSService</span></code>.</p>
181180
<dl class="field-list simple">
182181
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
183182
<dd class="field-odd"><ul class="simple">
@@ -192,9 +191,9 @@ <h3>Navigation</h3>
192191
<li><p><strong>created</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.DateTimeField" title="(in Django v6.0)"><em>DateTimeField</em></a>) – Created</p></li>
193192
<li><p><strong>modified</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.DateTimeField" title="(in Django v6.0)"><em>DateTimeField</em></a>) – Modified</p></li>
194193
<li><p><strong>host_address</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.GenericIPAddressField" title="(in Django v6.0)"><em>GenericIPAddressField</em></a>) – Host address. The IP address of the host this session is running on</p></li>
194+
<li><p><strong>task_arn</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.CharField" title="(in Django v6.0)"><em>CharField</em></a>) – Task arn</p></li>
195195
<li><p><strong>http_port</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.PositiveIntegerField" title="(in Django v6.0)"><em>PositiveIntegerField</em></a>) – Http port. The mapped port for http traffic on the host</p></li>
196196
<li><p><strong>websocket_port</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.PositiveIntegerField" title="(in Django v6.0)"><em>PositiveIntegerField</em></a>) – Websocket port. The mapped port for websocket traffic on the host</p></li>
197-
<li><p><strong>logs</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.TextField" title="(in Django v6.0)"><em>TextField</em></a>) – Logs</p></li>
198197
<li><p><strong>ping_times</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.JSONField" title="(in Django v6.0)"><em>JSONField</em></a>) – Ping times</p></li>
199198
<li><p><strong>extra_env_vars</strong> (<a class="reference external" href="https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.JSONField" title="(in Django v6.0)"><em>JSONField</em></a>) – Extra env vars. Extra environment variables to include in this session</p></li>
200199
</ul>
@@ -274,43 +273,6 @@ <h3>Navigation</h3>
274273
</dl>
275274
</dd></dl>
276275

277-
<dl class="py property">
278-
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.service">
279-
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">service</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Service</span></span><a class="headerlink" href="#grandchallenge.workstations.models.Session.service" title="Link to this definition"></a></dt>
280-
<dd><dl class="field-list simple">
281-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
282-
<dd class="field-odd"><p><em>The service for this session, could be active or inactive.</em></p>
283-
</dd>
284-
</dl>
285-
</dd></dl>
286-
287-
<dl class="py method">
288-
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.start">
289-
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grandchallenge/workstations/models.html#Session.start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grandchallenge.workstations.models.Session.start" title="Link to this definition"></a></dt>
290-
<dd><p>Starts the service for this session, ensuring that the
291-
<code class="docutils literal notranslate"><span class="pre">workstation_image</span></code> is ready to be used and that
292-
<code class="docutils literal notranslate"><span class="pre">WORKSTATIONS_MAXIMUM_SESSIONS</span></code> has not been reached in this region.</p>
293-
<dl class="field-list simple">
294-
<dt class="field-odd">Raises<span class="colon">:</span></dt>
295-
<dd class="field-odd"><p><strong>ComponentException</strong> – If the service cannot be started.</p>
296-
</dd>
297-
<dt class="field-even">Return type<span class="colon">:</span></dt>
298-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
299-
</dd>
300-
</dl>
301-
</dd></dl>
302-
303-
<dl class="py method">
304-
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.stop">
305-
<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grandchallenge/workstations/models.html#Session.stop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grandchallenge.workstations.models.Session.stop" title="Link to this definition"></a></dt>
306-
<dd><p>Stop the service for this session, cleaning up all of the containers.</p>
307-
<dl class="field-list simple">
308-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
309-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
310-
</dd>
311-
</dl>
312-
</dd></dl>
313-
314276
<dl class="py property">
315277
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.task_kwargs">
316278
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">task_kwargs</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a></span><a class="headerlink" href="#grandchallenge.workstations.models.Session.task_kwargs" title="Link to this definition"></a></dt>
@@ -321,20 +283,6 @@ <h3>Navigation</h3>
321283
</dl>
322284
</dd></dl>
323285

324-
<dl class="py method">
325-
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.update_status">
326-
<span class="sig-name descname"><span class="pre">update_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grandchallenge/workstations/models.html#Session.update_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grandchallenge.workstations.models.Session.update_status" title="Link to this definition"></a></dt>
327-
<dd><p>Updates the status of this session.</p>
328-
<dl class="field-list simple">
329-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
330-
<dd class="field-odd"><p><strong>status</strong> (<span class="sphinx_autodoc_typehints-type">((0, Queued), (1, Started), (2, Running), (3, Failed), (4, Stopped))</span>) – The new status for this session.</p>
331-
</dd>
332-
<dt class="field-even">Return type<span class="colon">:</span></dt>
333-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
334-
</dd>
335-
</dl>
336-
</dd></dl>
337-
338286
<dl class="py property">
339287
<dt class="sig sig-object py" id="grandchallenge.workstations.models.Session.workstation_url">
340288
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">workstation_url</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><a class="headerlink" href="#grandchallenge.workstations.models.Session.workstation_url" title="Link to this definition"></a></dt>

0 commit comments

Comments
 (0)