Skip to content

Commit da47bf3

Browse files
authored
Update docs and Dockerfiles (#1475)
1 parent 2e28925 commit da47bf3

90 files changed

Lines changed: 386 additions & 438 deletions

File tree

Some content is hidden

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

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Reporting bugs and asking questions
66

77
You can post questions or issues or feedback through the following channels:
88

9-
1. [Github Discussions](https://github.com/lithops-cloud/lithops/discussions): For discussions about development, questions about usage, and feature requests.
9+
1. [GitHub Discussions](https://github.com/lithops-cloud/lithops/discussions): For discussions about development, questions about usage, and feature requests.
1010
2. [GitHub Issues](https://github.com/lithops-cloud/lithops/issues): For bug reports and feature requests.
1111

1212

@@ -17,7 +17,7 @@ To contribute a patch:
1717
harder to merge in a large change with a lot of disjoint features.
1818
2. Submit the patch as a GitHub pull request against the master branch.
1919
3. Make sure that your code passes the tests.
20-
4. Make sure that your code passes the linter. Install `flake8` with `pip3 install flake8` and run the following command until you don't see any linting error:
20+
4. Make sure that your code passes the linter. Install `flake8` with `pip3 install flake8` and run the following command until you see no linting errors:
2121
```bash
2222
flake8 lithops --count --max-line-length=180 --statistics --ignore W605,W503
2323
```
@@ -27,7 +27,7 @@ To contribute a patch:
2727
Testing
2828
-------
2929

30-
To test that all is working as expected, you must install `pytest`, navigate to the tests folder `lithops/tests/`, and execute:
30+
To test that everything is working as expected, you must install `pytest`, navigate to the tests folder `lithops/tests/`, and execute:
3131
```bash
3232
pytest -v
3333
```

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</p>
66

77
<p align="center">
8-
<a aria-label="License" href="https://github.com/lithops-cloud/lithops/blob/master/LICENSE"><img alt="" src="https://img.shields.io/github/license/lithops-cloud/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a aria-label="PyPi" href="https://pypi.org/project/lithops/"><img alt="" src="https://img.shields.io/pypi/v/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a aria-label="Python" href="#lithops"><img alt="" src="https://img.shields.io/pypi/pyversions/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a href="https://pypistats.org/packages/lithops"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/lithops?label=pypi%7Cdownloads&style=for-the-badge&labelColor=000000"></a>&nbsp<a href="https://deepwiki.com/lithops-cloud/lithops" target="_blank" rel="noopener"><img alt="Ask DeepWiki" src="https://img.shields.io/badge/DeepWiki-Ask%20DeepWiki-blue.svg?style=for-the-badge&labelColor=000000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==" style="vertical-align:middle;"></a>
8+
<a aria-label="License" href="https://github.com/lithops-cloud/lithops/blob/master/LICENSE"><img alt="" src="https://img.shields.io/github/license/lithops-cloud/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a aria-label="PyPI" href="https://pypi.org/project/lithops/"><img alt="" src="https://img.shields.io/pypi/v/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a aria-label="Python" href="#lithops"><img alt="" src="https://img.shields.io/pypi/pyversions/lithops?style=for-the-badge&labelColor=000000"></a>&nbsp<a href="https://pypistats.org/packages/lithops"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/lithops?label=pypi%7Cdownloads&style=for-the-badge&labelColor=000000"></a>&nbsp<a href="https://deepwiki.com/lithops-cloud/lithops" target="_blank" rel="noopener"><img alt="Ask DeepWiki" src="https://img.shields.io/badge/DeepWiki-Ask%20DeepWiki-blue.svg?style=for-the-badge&labelColor=000000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==" style="vertical-align:middle;"></a>
99
</p>
1010

1111
Lithops is a Python multi-cloud distributed computing framework that lets you run unmodified Python code at massive scale across cloud, HPC, and on-premise platforms. It supports major cloud providers and Kubernetes platforms, running your code transparently without requiring you to manage deployment or infrastructure.
@@ -14,7 +14,7 @@ Lithops is ideal for highly parallel workloads—such as Monte Carlo simulations
1414

1515
## Installation
1616

17-
1. Install Lithops from the PyPi repository:
17+
1. Install Lithops from the PyPI repository:
1818

1919
```bash
2020
pip install lithops
@@ -40,7 +40,7 @@ Lithops provides an extensible backend architecture (compute, storage) designed
4040

4141
## High-level API
4242

43-
Lithops is shipped with 2 different high-level Compute APIs, and 2 high-level Storage APIs
43+
Lithops ships with 2 different high-level Compute APIs, and 2 high-level Storage APIs.
4444

4545
<div align="center">
4646
<table>

config/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
# Lithops configuration
22

3-
By default Lithops works on Localhost if no configuration is provided. To run workloads on the Cloud, you must configure both a compute and a storage backend. Failing to configure them properly will prevent Lithops to submit workloads. Lithops configuration can be provided either in a configuration file or in runtime via a Python dictionary.
3+
By default Lithops works on Localhost if no configuration is provided. To run workloads on the Cloud, you must configure both a compute and a storage backend. Failing to configure them properly will prevent Lithops from submitting workloads. Lithops configuration can be provided either in a configuration file or at runtime via a Python dictionary.
44

55
### Configuration file
66

77
To configure Lithops through a [configuration file](config_template.yaml) you have multiple options:
88

9-
1. Create a new file called `config` in the `~/.lithops` folder (i.e: `~/.lithops/config`).
9+
1. Create a new file called `config` in the `~/.lithops` folder (i.e., `~/.lithops/config`).
1010

1111
2. Create a new file called `.lithops_config` in the root directory of your project from where you will execute your Lithops scripts.
1212

13-
3. Create a new file called `config` in the `/etc/lithops/` folder (i.e: `/etc/lithops/config`). Useful for sharing the config file on multi-user machines.
13+
3. Create a new file called `config` in the `/etc/lithops/` folder (i.e., `/etc/lithops/config`). Useful for sharing the config file on multi-user machines.
1414

1515
4. Create the config file in any other location and configure the `LITHOPS_CONFIG_FILE` system environment variable:
1616

1717
LITHOPS_CONFIG_FILE=<CONFIG_FILE_LOCATION>
1818

1919
### Configuration keys in runtime
2020

21-
An alternative mode of configuration is to use a python dictionary. This option allows to pass all the configuration details as part of the Lithops invocation in runtime. An entire list of sections and keys is [here](config_template.yaml)
21+
An alternative mode of configuration is to use a Python dictionary. This option allows you to pass all the configuration details as part of the Lithops invocation at runtime. The full list of sections and keys is [here](config_template.yaml)
2222

2323
## Compute and Storage backends
24-
Choose your compute and storage engines from the table below
24+
Choose your compute and storage backends from the table below
2525

2626
<table>
2727
<tr>
@@ -49,7 +49,7 @@ Storage Backends
4949

5050
<b>Serverless (FaaS) Backends:</b>
5151
- [AWS Lambda](../docs/source/compute_config/aws_lambda.md)
52-
- [Google Cloud Functions](../docs/source/compute_config/gcp_functions.md)
52+
- [Google Cloud Run functions](../docs/source/compute_config/gcp_functions.md)
5353
- [Azure Functions](../docs/source/compute_config/azure_functions.md)
5454
- [Aliyun Functions](../docs/source/compute_config/aliyun_functions.md)
5555
- [Oracle Cloud Functions](../docs/source/compute_config/oracle_functions.md)
@@ -59,7 +59,7 @@ Storage Backends
5959
- [IBM Code Engine](../docs/source/compute_config/code_engine.md)
6060
- [AWS Batch](../docs/source/compute_config/aws_batch.md)
6161
- [Google Cloud Run](../docs/source/compute_config/gcp_cloudrun.md)
62-
- [Azure Container APPs](../docs/source/compute_config/azure_containers.md)
62+
- [Azure Container Apps](../docs/source/compute_config/azure_containers.md)
6363
- [Kubernetes](../docs/source/compute_config/kubernetes.md)
6464
- [Knative](../docs/source/compute_config/knative.md)
6565
- [Singularity](../docs/source/compute_config/singularity.md)

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Object Storage Made Easy
5656
Lithops simplifies working with data lakes and object storage by providing:
5757

5858
- 🔍 **Automatic data discovery**: Detects and lists files across nested directories.
59-
- 📂 **Transparent data partitioning**: Splits large files (e.g., CSV, Parquet, JSON) into chunks for efficient parallel processing.
59+
- 📂 **Transparent data partitioning**: Splits large text-based files (for example, CSV) into chunks for efficient parallel processing.
6060
- 🧰 **Unified, Pythonic API**: Interact with your data using a single interface, regardless of where it's stored.
6161

6262
You write simple Python code — Lithops handles the complexity of parallel I/O, data distribution, and storage backends under the hood.

docs/source/airflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Airflow/Lithops integration allows Airflow users to keep all of their Lithop
66
define task dependencies by moving data through Python functions.
77

88

9-
Refer to the `integration repository <https://github.com/lithops-cloud/airflow-plugin>`_ .
9+
Refer to the `integration repository <https://github.com/lithops-cloud/airflow-plugin>`_.
1010

1111
Examples
1212
--------
@@ -18,7 +18,7 @@ Define a function in a separate file (``my_functions.py``):
1818
.. code:: python
1919
2020
def add(x, y):
21-
return x + y
21+
return x + y
2222
2323
2424
Import the Lithops operator and the function, and create the DAG to execute:
@@ -48,7 +48,7 @@ Import the Lithops operator and the function, and create the DAG to execute:
4848
4949
mult_num_map = LithopsMapOperator(
5050
task_id='mult_num_map',
51-
map_function=example_functions.add_num,
51+
map_function=add,
5252
iterdata_from_task={'a': 'gen_list'},
5353
extra_args={'b': 10},
5454
dag=dag

docs/source/api_stats.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Lithops provides built-in internal tools to supply the user with technical stati
88
Execution summary plots
99
-----------------------
1010

11-
The :code:`plot()` method from :code:`FunctionExecutor` creates a scatter plot and a histogram plot showing a summary of the tasks executed by a :code:`FunctionExecutor`. By default, lithops creates a :code:`plots/` directory in the working directory path containing both plots in PNG format. For more details refer to the `FunctionExecutor API reference <https://lithops-cloud.github.io/docs/source/api_futures.html>`_.
11+
The :code:`plot()` method from :code:`FunctionExecutor` creates a scatter plot and a histogram plot showing a summary of the tasks executed by a :code:`FunctionExecutor`. By default, Lithops creates a :code:`plots/` directory in the working directory path containing both plots in PNG format. For more details, refer to the `FunctionExecutor API reference <https://lithops-cloud.github.io/docs/source/api_futures.html>`_.
1212

1313
To get started, first install Lithops and the plotting dependencies with:
1414

@@ -115,7 +115,7 @@ The user can obtain these statistics through the future object:
115115
* - Stat
116116
- Description
117117
* - :code:`func_data_size_bytes`
118-
- Size in bytes of the input data processed by this function. That is, the object size of the input list item processed by this function. Note that if the function processes data obtained from object storage, this value does not include the size of that data, only those that have been serialized and sent from the host process to the function.
118+
- Size in bytes of the input data processed by this function. That is, the object size of the input list item processed by this function. Note that if the function processes data obtained from object storage, this value does not include the size of that dataonly the data serialized and sent from the host process to the function.
119119
* - :code:`func_module_size_bytes`
120120
- Size in bytes of the dependencies (function and modules) serialized and uploaded by the host process.
121121
* - :code:`func_result_size`
@@ -131,7 +131,7 @@ The user can obtain these statistics through the future object:
131131
* - :code:`host_job_serialize_time`
132132
- Total time taken by the host process to serialize the input data and dependencies (functions and modules).
133133
* - :code:`host_result_done_tstamp`
134-
- Timestamp of when host received the function result from cloud object storage.
134+
- Timestamp of when the host received the function result from cloud object storage.
135135
* - :code:`host_result_query_count`
136136
- Number of queries to the object storage to get the result object.
137137
* - :code:`host_status_done_tstamp`
@@ -143,7 +143,7 @@ The user can obtain these statistics through the future object:
143143
* - :code:`worker_cold_start`
144144
- Indicates whether it was a "warm" invocation (the container was already running) or "cold" (the container had to be deployed).
145145
* - :code:`worker_end_tstamp`
146-
- Timestamp in which the worker function had finished its execution.
146+
- Timestamp when the worker function finished its execution.
147147
* - :code:`worker_exec_time`
148148
- Total execution time of the worker function (Lithops wrapper + user-defined function execution time).
149149
* - :code:`worker_func_cpu_usage`

docs/source/api_storage_os.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Cloud Proxy Storage API
4343

4444
Similar to Python's built-in function `open() <https://docs.python.org/3/library/functions.html#open>`__.
4545

46-
Manipulate an object stored in Cloud Object Storage.
46+
Manipulate an object storaged in Cloud Object Storage.
4747

4848
+-------------+-------------------------------------------------------------------------------------------------------------------+
4949
| Parameter | Description |

0 commit comments

Comments
 (0)