Skip to content

Commit

Permalink
docs: review update
Browse files Browse the repository at this point in the history
  • Loading branch information
etrapnell-nist committed Jan 21, 2025
1 parent 5d4384b commit 136be8b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/source/getting-started/additional-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After creating the dioptra-worker user, click "Signup" and register a separate u
Create a Queue
______________

Queues are an organizational tool used to manage submitted jobs. The workers that were instantiated when creating the Dioptra deployment watch a Queue and process jobs one at a time in sequence. A Queue is needed to submit the “Hello World” job to, so the next step is to register one.
Queues are an organizational tool used to manage submitted jobs. The workers that were instantiated when creating the Dioptra deployment watch a Queue and process jobs one at a time in sequence. A Queue is needed to submit and process jobs. The next step is to register a queue to enable jobs to run.

From the top menu, navigate to the Queues page and then click "Create". For the queue name, put "tensorflow_cpu" and "public" for the group. "tensorflow_cpu" is required for the queue name because it is what the deployment workers are watching. To finish creating the queue, add a description if desired, then click "Confirm".

Expand Down
13 changes: 6 additions & 7 deletions docs/source/user-guide/the-web-frontend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,26 @@
.. _user-guide-the-web-frontend:

The Web Frontend User's Guide
=============================
Using the Web Frontend By Example
=================================

.. include:: /_glossary_note.rst

Dioptra provides a web-based user interface for running, tracking, and organizing machine learning experiments using the open-source technologies and architectures found in real-world AI applications. A demonstration of a simple Hello World example will be shown here.
Dioptra provides a web-based user interface for running, tracking, and organizing machine learning experiments using the open-source technologies and architectures found in real-world AI applications. The following "Hello World" example will demonstrate how to interact with the web-based user interface.

**Please make sure to have completed these prerequisites for using the front end**: :doc:`/getting-started/building-the-containers`, :doc:`/getting-started/running-dioptra`, and :doc:`/getting-started/additional-configuration`
**Please make sure to have completed all prerequisites for using the front end**: :doc:`/getting-started/building-the-containers`, :doc:`/getting-started/running-dioptra`, and :doc:`/getting-started/additional-configuration`


Using Dioptra (Hello World Example)
===================================

This guide is a walk-through for setting up and executing a simple “Hello World” example in the Dioptra frontend. It will familiarize the reader with some of the core concepts behind Dioptra. It assumes that the steps to configure and instantiate a Dioptra deployment have already been followed as outlined in the `Getting Started`_ section of the documentation.
This guide is a walk-through for setting up and executing a simple “Hello World” example in the Dioptra frontend. It will familiarize the reader with some of the core concepts behind Dioptra. It assumes that the steps to configure and instantiate a Dioptra deployment have already been followed as outlined in the prerequisites listed above.

.. _Getting Started: ../getting-started/building-the-containers

Create a Plugin
_______________

Plugins are Python packages that contain code and the metadata to define tasks to execute in a Dioptra job. They perform a variety of basic, low-level functions such as loading models, preparing data, and computing metrics, and implementing atomic portions of attacks and defenses. A plugin can contain one or more python files, each of which contains tasks. A plugin is needed in order to assign tasks for the “Hello World” example.
Plugins are Python packages that contain code and metadata to define tasks to execute in a Dioptra job. They perform a variety of basic, low-level functions such as loading models, preparing data, and computing metrics, and implementing atomic portions of attacks and defenses. A plugin can contain one or more python files, each of which contains tasks. A plugin is needed in order to assign tasks for the “Hello World” example.

From the top menu, navigate to the Plugins page and then click "Create". Put "hello_world" for the plugin name and "public" for the group. If desired, add a description. Click "Confirm".

Expand Down

0 comments on commit 136be8b

Please sign in to comment.