Skip to content
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.

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

Chore: Typos fixed in files of doc/source/concepts/ folder #1821

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions doc/source/concepts/api_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ electron (lower-case "e")

The {code}`@covalent.electron` decorator makes the function runnable in a Covalent executor. It does not change the function in any other way.

The function decorated with {code}`@covalent.electron` can be any Python function; however, it should be thought of, and operate as, a single task. Best practice is to write an electron with a single, well defined purpose; for example, performing a single tranformation of some input or writing or reading a record to a file or database.
The function decorated with {code}`@covalent.electron` can be any Python function; however, it should be thought of, and operate as, a single task. Best practice is to write an electron with a single, well defined purpose; for example, performing a single transformation of some input or writing or reading a record to a file or database.

Here is a simple electron that adds two numbers:

Expand Down Expand Up @@ -67,13 +67,13 @@ The function decorated with {code}`@covalent.lattice` must contain one or more e

For Covalent to work properly, the lattice must operate on data only by calling electrons. By "work properly," we mean "dispatch all tasks to executors." The flexibility and power of Covalent comes from the ability to assign and reassign tasks (electrons) to executors, which has two main advantages, *hardware independence* and *parallelization*.

Hardware indepdendence
Hardware independence

: The task's code is decoupled from the details of the hardware it is run on.

Parallelization

: Independent tasks can be run in parallel on the same or different backends. Here, *indepedent* means that for any two tasks, their inputs are unaffected by each others' execution outcomes (that is, their outputs or side effects). The Covalent dispatcher can run independent electrons in parallel. For example, in the workflow structure shown below, electron 2 and electron 3 are executed in parallel.
: Independent tasks can be run in parallel on the same or different backends. Here, *independent* means that for any two tasks, their inputs are unaffected by each others' execution outcomes (that is, their outputs or side effects). The Covalent dispatcher can run independent electrons in parallel. For example, in the workflow structure shown below, electron 2 and electron 3 are executed in parallel.

```{image} ./images/parallel_lattice.png
:align: center
Expand Down
2 changes: 1 addition & 1 deletion doc/source/concepts/ui_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Pending (orange)

## Transport Graph

Click on a dispatch ID to view the {ref}`transport graph <Transport Graph>`. The nodes in the graph shows the executor, name, and ID number of each task. The graph's edges are labeled with the data dependencies betwen nodes.
Click on a dispatch ID to view the {ref}`transport graph <Transport Graph>`. The nodes in the graph shows the executor, name, and ID number of each task. The graph's edges are labeled with the data dependencies between nodes.

:::{note}
In some default display configurations, edges can run behind other nodes, labels can be obscured, and other display anomalies can occur. The graph view features {ref}`controls<graph_controls>` that you can use to adjust the graph display.
Expand Down
Loading