Skip to content

Commit d325f79

Browse files
committed
Update docs to 3.6.1
1 parent 2929450 commit d325f79

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+180
-79
lines changed

docs/_sources/source/api_futures.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ The core abstraction in Lithops is the **executor**, responsible for orchestrati
77

88
To get started, you typically import `lithops` and create an executor instance to run your code. Lithops provides a flexible set of executors to suit different needs.
99

10-
### Primary Executors
10+
Primary Executors
11+
-----------------
1112

1213
* **FunctionExecutor** (`lithops.FunctionExecutor()`):
1314
The main, generic executor that automatically selects its execution mode based on the provided configuration.
@@ -17,7 +18,8 @@ To get started, you typically import `lithops` and create an executor instance t
1718
A robust wrapper around `FunctionExecutor` that transparently handles retries on failed tasks.
1819
It supports all features of `FunctionExecutor` with added automatic retry logic, improving fault tolerance and reliability for unstable or transient failure-prone environments.
1920

20-
### Secondary Executors
21+
Secondary Executors
22+
-------------------
2123

2224
For more specialized use cases, Lithops also provides explicit executors for each execution mode:
2325

@@ -30,14 +32,12 @@ For more specialized use cases, Lithops also provides explicit executors for eac
3032
* **StandaloneExecutor** (`lithops.StandaloneExecutor()`):
3133
Runs jobs on standalone compute backends such as clusters or virtual machines, suitable for long-running or resource-heavy tasks.
3234

33-
---
3435

35-
### Configuration and Initialization
36+
Configuration and Initialization
37+
================================
3638

3739
By default, executors load configuration from the Lithops configuration file (e.g., `lithops_config.yaml`). You can also supply configuration parameters programmatically via a Python dictionary when creating an executor instance. Parameters passed explicitly override those in the config file, allowing for flexible customization on the fly.
3840

39-
---
40-
4141
This layered executor design lets Lithops provide a powerful, unified API for parallel function execution — from local development to multi-cloud production deployments with fault tolerance and retries built-in.
4242

4343

docs/_sources/source/compute_config/kubernetes_rabbitmq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
All of these changes are **ideal** for pipelines where launching **hundreds of parallel tasks as quickly as possible** is a critical requirement, in a fixed size heterogeneous cluster.
66

7-
### Changes of K8s RabbitMQ
7+
## Changes of K8s RabbitMQ
88

99
* **Utilization of RabbitMQ:** Within this architecture, RabbitMQ is employed to launch group invocations in a single call, avoiding the need for multiple calls for each function execution. Additionally, it enables data exchange between the client and running pods, bypassing the Storage Backend as an intermediary, which is slower. This accelerates and streamlines communication significantly.
1010

@@ -74,25 +74,25 @@ All of these tests consist of running 225 functions on a 2-node cluster, each wi
7474

7575
In this scenario, it is evident that the invocation time is consistently reduced by a factor of **up to 5x** on cold start and **up to 7x** on warm start. This represents a significant enhancement for parallel function execution.
7676

77-
#### Plot 1: Kubernetes K8s original.
77+
- Plot 1: Kubernetes K8s original.
7878

7979
*Elapsed time = 16,9 sec.*
8080

8181
![Kubernetes K8s original plot](../images/plots_kubernetes/k8s_original_histogram.png)
8282

83-
#### Plot 2: Kubernetes K8s original with master on Warm Start.
83+
- Plot 2: Kubernetes K8s original with master on Warm Start.
8484

8585
*Elapsed time = 8,1 sec.*
8686

8787
![Kubernetes K8s original with Warm Start plot](../images/plots_kubernetes/k8s_original_warm_start_histogram.png)
8888

89-
#### Plot 3: Kubernetes K8s RabbitMQ.
89+
- Plot 3: Kubernetes K8s RabbitMQ.
9090

9191
*Elapsed time = 8 sec.*
9292

9393
![Kubernetes K8s RabbitMQ plot](../images/plots_kubernetes/rabbitmq_histogram.png)
9494

95-
#### Plot 4: Kubernetes K8s RabbitMQ with workers on Warm Start.
95+
- Plot 4: Kubernetes K8s RabbitMQ with workers on Warm Start.
9696

9797
*Elapsed time = 5,9 sec.*
9898

docs/_sources/source/contributing.rst

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,39 @@ To contribute a patch
1818
1. Break your work into small, single-purpose patches if possible. It's much
1919
harder to merge in a large change with a lot of disjoint features.
2020
2. Submit the patch as a GitHub pull request against the master branch.
21-
3. Make sure that your code passes the unit tests.
22-
4. Make sure that your code passes the linter.
23-
5. Add new unit tests for your code.
24-
25-
26-
Unit testing
27-
------------
28-
29-
To test that all is working as expected, run either:
30-
31-
.. code::
32-
33-
$ lithops test
34-
35-
36-
.. code::
37-
38-
$ python3 -m lithops.tests.tests_main
39-
40-
41-
Please follow the guidelines in :ref:`testing` for more details.
21+
3. Make sure that your code passes the tests.
22+
4. Make sure that your code passes the linter. Install `flake8` with `pip3 install flake8` and run the next command until you don't see any linitng error:
23+
```bash
24+
flake8 lithops --count --max-line-length=180 --statistics --ignore W605,W503
25+
```
26+
5. Add new tests for your code.
27+
28+
29+
Testing
30+
-------
31+
32+
To test that all is working as expected, you must install `pytest`, navigate to the tests folder `lithops/tests/`, and execute:
33+
```bash
34+
pytest -v
35+
```
36+
37+
If you made changes to a specific backend, please run tests on that backend.
38+
For example, if you made changes to the AWS Lambda backend, execute the tests with:
39+
```bash
40+
pytest -v --backend aws_lambda --storage aws_s3
41+
```
42+
43+
You can list all the available tests using:
44+
```bash
45+
pytest --collect-only
46+
```
47+
48+
To run a specific test or group of tests, use the `-k` parameter, for example:
49+
```bash
50+
pytest -v --backend localhost --storage localhost -k test_map
51+
```
52+
53+
To view all the Lithops logs during the tests, and in DEBUG mode, execute:
54+
```bash
55+
pytest -o log_cli=true --log-cli-level=DEBUG --backend localhost --storage localhost
56+
```

docs/genindex.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@
206206
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lithops Compute API</span></p>
207207
<ul class="nav bd-sidenav">
208208
<li class="toctree-l1"><a class="reference internal" href="source/api_futures.html">Lithops Futures API</a></li>
209+
209210
<li class="toctree-l1"><a class="reference internal" href="source/functions.html">Functions and Parameters</a></li>
210211
<li class="toctree-l1"><a class="reference internal" href="source/worker_granularity.html">Worker Granularity</a></li>
211212
<li class="toctree-l1"><a class="reference internal" href="source/notebooks/function_chaining.html">Function chaining</a></li>

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@
208208
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lithops Compute API</span></p>
209209
<ul class="nav bd-sidenav">
210210
<li class="toctree-l1"><a class="reference internal" href="source/api_futures.html">Lithops Futures API</a></li>
211+
211212
<li class="toctree-l1"><a class="reference internal" href="source/functions.html">Functions and Parameters</a></li>
212213
<li class="toctree-l1"><a class="reference internal" href="source/worker_granularity.html">Worker Granularity</a></li>
213214
<li class="toctree-l1"><a class="reference internal" href="source/notebooks/function_chaining.html">Function chaining</a></li>

docs/objects.inv

-84 Bytes
Binary file not shown.

docs/py-modindex.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@
209209
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lithops Compute API</span></p>
210210
<ul class="nav bd-sidenav">
211211
<li class="toctree-l1"><a class="reference internal" href="source/api_futures.html">Lithops Futures API</a></li>
212+
212213
<li class="toctree-l1"><a class="reference internal" href="source/functions.html">Functions and Parameters</a></li>
213214
<li class="toctree-l1"><a class="reference internal" href="source/worker_granularity.html">Worker Granularity</a></li>
214215
<li class="toctree-l1"><a class="reference internal" href="source/notebooks/function_chaining.html">Function chaining</a></li>

docs/search.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@
208208
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lithops Compute API</span></p>
209209
<ul class="nav bd-sidenav">
210210
<li class="toctree-l1"><a class="reference internal" href="source/api_futures.html">Lithops Futures API</a></li>
211+
211212
<li class="toctree-l1"><a class="reference internal" href="source/functions.html">Functions and Parameters</a></li>
212213
<li class="toctree-l1"><a class="reference internal" href="source/worker_granularity.html">Worker Granularity</a></li>
213214
<li class="toctree-l1"><a class="reference internal" href="source/notebooks/function_chaining.html">Function chaining</a></li>

docs/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.

docs/source/airflow.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@
209209
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lithops Compute API</span></p>
210210
<ul class="nav bd-sidenav">
211211
<li class="toctree-l1"><a class="reference internal" href="api_futures.html">Lithops Futures API</a></li>
212+
212213
<li class="toctree-l1"><a class="reference internal" href="functions.html">Functions and Parameters</a></li>
213214
<li class="toctree-l1"><a class="reference internal" href="worker_granularity.html">Worker Granularity</a></li>
214215
<li class="toctree-l1"><a class="reference internal" href="notebooks/function_chaining.html">Function chaining</a></li>

0 commit comments

Comments
 (0)