diff --git a/.gitmodules b/.gitmodules index d756fb5fd..e69de29bb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +0,0 @@ -[submodule "docs/examples"] - path = docs/examples - url = https://github.com/funcx-faas/examples - branch = main diff --git a/Makefile b/Makefile index 790272440..da36c62e1 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,9 @@ .venv-docs/bin/pip install -U pip setuptools .venv-docs/bin/pip install './funcx_sdk[docs]' './funcx_endpoint' -.PHONY: docs +.PHONY: lint docs +lint: + pre-commit run -a docs: .venv-docs # clean the build dir before rebuilding cd docs; rm -rf _build/ diff --git a/changelog.d/20220308_233538_sirosen_furo_docs.rst b/changelog.d/20220308_233538_sirosen_furo_docs.rst new file mode 100644 index 000000000..56d723433 --- /dev/null +++ b/changelog.d/20220308_233538_sirosen_furo_docs.rst @@ -0,0 +1,5 @@ +Changed +^^^^^^^ + +- ``FuncXExeuctor`` is now importable from the top-level namespace, as in + ``from funcx import FuncXExecutor`` diff --git a/docs/Tutorial.rst b/docs/Tutorial.rst index 745e3d723..2cf458bd1 100644 --- a/docs/Tutorial.rst +++ b/docs/Tutorial.rst @@ -80,7 +80,10 @@ Functions with Arguments funcX supports registration and invocation of functions with arbitrary arguments and returned parameters. funcX will serialize any ``*args`` and ``**kwargs`` when invoking a function and it will serialize any return parameters or exceptions. - Note: funcX uses standard Python serilaization libraries (e.g., Pickle, Dill) it also limits the size of input arguments and returned parameters to 5MB. + +.. note:: + + funcX uses standard Python serilaization libraries (e.g., Pickle, Dill) it also limits the size of input arguments and returned parameters to 5MB. The following example shows a function that computes the sum of a list of input arguments. First we register the function as above. diff --git a/docs/_static/images/funcX-dark-cropped.png b/docs/_static/images/funcX-dark-cropped.png new file mode 100644 index 000000000..b1d7a04e3 Binary files /dev/null and b/docs/_static/images/funcX-dark-cropped.png differ diff --git a/docs/_static/images/funcX-dark.png b/docs/_static/images/funcX-dark.png new file mode 100644 index 000000000..6eab5a07e Binary files /dev/null and b/docs/_static/images/funcX-dark.png differ diff --git a/docs/_static/images/funcX-light-cropped.png b/docs/_static/images/funcX-light-cropped.png new file mode 100644 index 000000000..6cad947a0 Binary files /dev/null and b/docs/_static/images/funcX-light-cropped.png differ diff --git a/docs/_static/images/funcX-light.png b/docs/_static/images/funcX-light.png new file mode 100644 index 000000000..74996b39e Binary files /dev/null and b/docs/_static/images/funcX-light.png differ diff --git a/docs/changelog.rst b/docs/changelog.rst index 0703118a6..8bced0070 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,8 +6,8 @@ Changelog funcx & funcx-endpoint v0.3.7 ----------------------------- - Bug Fixes - ^^^^^^^^^ +Bug Fixes +^^^^^^^^^ - When a provider raised an exception, that exception was then mishandled and presented as an AttributeError. This handling now no longer corrupts @@ -483,7 +483,8 @@ New Functionality * funcx-endpoint connects to a forwarder service over an encrypted (Curve25519 elliptic curve) ZMQ channel using the server certificates. * If the connection is terminated this whole process repeats. -* Significant changes to the `Config object`. All options related to executors have been moved from the top level Config object to the executor object. Refer to the `configuration section for more details. Here's an example of the config change: +* Significant changes to the `Config object`. All options related to executors have been moved from the top level Config object to the executor object. + Refer to the `configuration `_ section for more details. Here's an example of the config change: This is the old style config: @@ -542,8 +543,8 @@ New Functionality .. code-block:: json { - 'status': 'Success', - 'task_uuids': ['task_id_1', 'task_id_2', ...] + "status": "Success", + "task_uuids": ["task_id_1", "task_id_2", "..."] } This is the new response format, where some task submissions have failed: @@ -551,21 +552,21 @@ New Functionality .. code-block:: json { - 'response': 'batch', - 'results': [ + "response": "batch", + "results": [ { - 'status': 'Success', - 'task_uuid': 'task_id_1', - 'http_status_code': 200 + "status": "Success", + "task_uuid": "task_id_1", + "http_status_code": 200 }, { - 'status': 'Failed', - 'code': 1, - 'task_uuid': 'task_id_2', - 'http_status_code': 4XX/5XX, - 'error_args': [...] + "status": "Failed", + "code": 1, + "task_uuid": "task_id_2", + "http_status_code": 400, + "error_args": ["..."] }, - ... + "..." ] } diff --git a/docs/conf.py b/docs/conf.py index b58252213..042c2d23a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,15 +23,10 @@ # ones. extensions = [ "sphinx.ext.autodoc", - "sphinx.ext.autosummary", "sphinx.ext.intersphinx", - # 'sphinx.ext.linkcode', "sphinx.ext.napoleon", - "sphinx.ext.autosectionlabel", ] -autosummary_generate = True - intersphinx_mapping = { "python": ("https://docs.python.org/3", None), } @@ -42,8 +37,12 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # theming, styles, and color options -pygments_style = "sphinx" -html_theme = "sphinx_rtd_theme" +pygments_style = "friendly" +pygments_dark_style = "monokai" # this is a furo-specific option +html_show_sourcelink = True +html_theme = "furo" html_static_path = ["_static"] -# disabled logo for now -- it looks bad on the RTD theme -# html_logo = "_static/logo.png" +html_theme_options = { + "light_logo": "images/funcX-light-cropped.png", + "dark_logo": "images/funcX-dark-cropped.png", +} diff --git a/docs/configuring.rst b/docs/configuring.rst index 2a7defed4..71a7d38b0 100644 --- a/docs/configuring.rst +++ b/docs/configuring.rst @@ -94,7 +94,7 @@ using the `CobaltProvider`. This configuration assumes that the script is being Polaris (ALCF) -^^^^^^^^^^^^^ +^^^^^^^^^^^^^^ .. image:: images/ALCF_Polaris.jpeg diff --git a/docs/endpoints.rst b/docs/endpoints.rst index 545692276..0eb5fade6 100644 --- a/docs/endpoints.rst +++ b/docs/endpoints.rst @@ -87,8 +87,10 @@ Once started, the endpoint uses a daemon process to run in the background. .. note:: If the endpoint was not stopped correctly previously (e.g., after a computer restart when the endpoint was running), the endpoint directory will be cleaned up to allow a fresh start -.. warning:: Only the owner of an endpoint is authorized to start an endpoint. Thus if you register an endpoint -using one identity and try to start an endpoint owned by another identity, it will fail. +.. warning:: + + Only the owner of an endpoint is authorized to start an endpoint. Thus if you register an endpoint + using one identity and try to start an endpoint owned by another identity, it will fail. Stopping an Endpoint diff --git a/docs/examples b/docs/examples deleted file mode 160000 index bf333337c..000000000 --- a/docs/examples +++ /dev/null @@ -1 +0,0 @@ -Subproject commit bf333337c0d0d99278eeac77dc4641561af24908 diff --git a/docs/executor.rst b/docs/executor.rst index 4b80e4f16..4cdf62435 100644 --- a/docs/executor.rst +++ b/docs/executor.rst @@ -13,8 +13,7 @@ Initializing the executor .. code-block:: python - from funcx import FuncXClient - from funcx.sdk.executor import FuncXExecutor + from funcx import FuncXClient, FuncXExecutor fx = FuncXExecutor(FuncXClient()) diff --git a/docs/index.rst b/docs/index.rst index 0a90d7f44..7a5f69f36 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -88,11 +88,12 @@ how to download and configure an endpoint for local (multi-process) execution. : :caption: Contents: quickstart + executor sdk endpoints Tutorial actionprovider - reference + reference/index debugging limits changelog diff --git a/docs/quickstart.rst b/docs/quickstart.rst index e008abd01..f43e98f69 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -56,7 +56,7 @@ To update a previously installed funcX to a newer version, use: ``python3 -m pip Running a function ------------------------- +------------------ After installing the funcX SDK, you can register functions and execute them on available endpoints. To use the SDK, you should first instantiate diff --git a/docs/reference.rst b/docs/reference.rst deleted file mode 100644 index 3d7d3742e..000000000 --- a/docs/reference.rst +++ /dev/null @@ -1,51 +0,0 @@ -Reference -######### - - -funcX SDK -========= - -.. autosummary:: - :toctree: stubs - :nosignatures: - - funcx - funcx.sdk.client.FuncXClient - funcx.sdk.utils.batch.Batch - funcx.serialize.base - funcx.serialize.concretes - -funcx-endpoint -============== - -.. autosummary:: - :toctree: stubs - :nosignatures: - - funcx_endpoint.endpoint.endpoint - funcx_endpoint.endpoint.endpoint_manager.EndpointManager - funcx_endpoint.endpoint.interchange.EndpointInterchange - funcx_endpoint.endpoint.taskqueue.TaskQueue - funcx_endpoint.strategies.base.BaseStrategy - funcx_endpoint.strategies.simple.SimpleStrategy - funcx_endpoint.strategies.kube_simple.KubeSimpleStrategy - - -Exceptions -========== - -.. autosummary:: - :toctree: stubs - :nosignatures: - - funcx.utils.errors.TaskPending - funcx.utils.errors.RegistrationError - funcx.utils.errors.FuncXUnreachable - funcx.utils.errors.MalformedResponse - funcx.utils.errors.FailureResponse - funcx.utils.errors.VersionMismatch - funcx.utils.errors.SerializationError - funcx.utils.errors.UserCancelledException - funcx.utils.errors.InvalidScopeException - funcx.utils.errors.MaxResultSizeExceeded - funcx.utils.errors.HTTPError diff --git a/docs/reference/client.rst b/docs/reference/client.rst new file mode 100644 index 000000000..87c2cafaa --- /dev/null +++ b/docs/reference/client.rst @@ -0,0 +1,6 @@ +The FuncX Client +================ + +.. autoclass:: funcx.FuncXClient + :members: + :member-order: bysource diff --git a/docs/reference/errors.rst b/docs/reference/errors.rst new file mode 100644 index 000000000..6e9a0b6df --- /dev/null +++ b/docs/reference/errors.rst @@ -0,0 +1,7 @@ +Errors +====== + +.. autoclass:: funcx.FuncxAPIError + :members: + :member-order: bysource + diff --git a/docs/reference/executor.rst b/docs/reference/executor.rst new file mode 100644 index 000000000..c4127eea7 --- /dev/null +++ b/docs/reference/executor.rst @@ -0,0 +1,7 @@ +The FuncX Executor +================== + +.. autoclass:: funcx.FuncXExecutor + :members: + :member-order: bysource + diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 000000000..18d9395bc --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,10 @@ +.. module:: funcx + +funcX SDK +========= + +.. toctree:: + + executor + client + errors diff --git a/docs/sdk.rst b/docs/sdk.rst index 31a0be2cd..b52cf6adb 100644 --- a/docs/sdk.rst +++ b/docs/sdk.rst @@ -1,5 +1,5 @@ -SDK -============ +FuncX SDK User Guide +==================== The **funcX SDK** provides a programmatic interface to funcX from Python. The SDK provides a convenient Pythonic interface to: @@ -59,6 +59,7 @@ is defined in the same way as any Python function before being registered with f Running Functions ----------------- + You can invoke a function using the UUID returned when registering the function. The `run()` function requires that you specify the function (`function_id`) and endpoint (`endpoint_id`) on which to execute the function. funcX will return a UUID for the executing function (called a task) via which you can @@ -95,10 +96,12 @@ task is still pending. Arguments and data ------------------ + funcX functions operate the same as any other Python function. You can pass arguments \*args and \**kwargs and return values from functions. The only constraint is that data passed to/from a funcX function must be -serializable (e.g., via Pickle) and fall within :ref:`Limits` . Input arguments can be passed to the function -using the `run()` function. The following example shows how strings can be passed to and from a function. +serializable (e.g., via Pickle) and fall within service limits. +Input arguments can be passed to the function using the `run()` function. +The following example shows how strings can be passed to and from a function. .. code-block:: python @@ -195,11 +198,3 @@ and a result if it is available. 'e453a993-73e6-4149-8078-86e7b8370c35': {'pending': True, 'status': 'waiting-for-ep'} } - - - -FuncXClient Reference: ----------------------- - -.. autoclass:: funcx.FuncXClient - :members: diff --git a/docs/stubs/funcx.rst b/docs/stubs/funcx.rst deleted file mode 100644 index 15ce10fc5..000000000 --- a/docs/stubs/funcx.rst +++ /dev/null @@ -1,23 +0,0 @@ -funcx -===== - -.. automodule:: funcx - - - - - - - - - - - - - - - - - - - diff --git a/docs/stubs/funcx.sdk.client.FuncXClient.rst b/docs/stubs/funcx.sdk.client.FuncXClient.rst deleted file mode 100644 index 155fde70d..000000000 --- a/docs/stubs/funcx.sdk.client.FuncXClient.rst +++ /dev/null @@ -1,65 +0,0 @@ -funcx.sdk.client.FuncXClient -============================ - -.. currentmodule:: funcx.sdk.client - -.. autoclass:: FuncXClient - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FuncXClient.__init__ - ~FuncXClient.add_to_whitelist - ~FuncXClient.batch_run - ~FuncXClient.create_batch - ~FuncXClient.delete - ~FuncXClient.delete_from_whitelist - ~FuncXClient.get - ~FuncXClient.get_batch_result - ~FuncXClient.get_container - ~FuncXClient.get_containers - ~FuncXClient.get_endpoint_status - ~FuncXClient.get_result - ~FuncXClient.get_task - ~FuncXClient.get_whitelist - ~FuncXClient.logout - ~FuncXClient.map_run - ~FuncXClient.patch - ~FuncXClient.post - ~FuncXClient.put - ~FuncXClient.qjoin_path - ~FuncXClient.register_container - ~FuncXClient.register_endpoint - ~FuncXClient.register_function - ~FuncXClient.run - ~FuncXClient.search_endpoint - ~FuncXClient.search_function - ~FuncXClient.set_app_name - ~FuncXClient.throttle_max_requests - ~FuncXClient.throttle_request_size - ~FuncXClient.update_function - ~FuncXClient.update_table - ~FuncXClient.version_check - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FuncXClient.BASE_USER_AGENT - ~FuncXClient.DEFAULT_MAX_REQUESTS - ~FuncXClient.DEFAULT_MAX_REQUEST_SIZE - ~FuncXClient.FUNCX_SCOPE - ~FuncXClient.FUNCX_SDK_CLIENT_ID - ~FuncXClient.TOKEN_DIR - ~FuncXClient.TOKEN_FILENAME - ~FuncXClient.allowed_authorizer_types - diff --git a/docs/stubs/funcx.sdk.utils.batch.Batch.rst b/docs/stubs/funcx.sdk.utils.batch.Batch.rst deleted file mode 100644 index 7c6e7a160..000000000 --- a/docs/stubs/funcx.sdk.utils.batch.Batch.rst +++ /dev/null @@ -1,23 +0,0 @@ -funcx.sdk.utils.batch.Batch -=========================== - -.. currentmodule:: funcx.sdk.utils.batch - -.. autoclass:: Batch - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Batch.__init__ - ~Batch.add - ~Batch.prepare - - - - - diff --git a/docs/stubs/funcx.serialize.base.rst b/docs/stubs/funcx.serialize.base.rst deleted file mode 100644 index 4568cf34c..000000000 --- a/docs/stubs/funcx.serialize.base.rst +++ /dev/null @@ -1,38 +0,0 @@ -funcx.serialize.base -==================== - -.. automodule:: funcx.serialize.base - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - RemoteExceptionWrapper - SerializerError - fxPicker_enforcer - fxPicker_shared - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - DeserializationError - - - - - diff --git a/docs/stubs/funcx.serialize.concretes.rst b/docs/stubs/funcx.serialize.concretes.rst deleted file mode 100644 index 839709936..000000000 --- a/docs/stubs/funcx.serialize.concretes.rst +++ /dev/null @@ -1,39 +0,0 @@ -funcx.serialize.concretes -========================= - -.. automodule:: funcx.serialize.concretes - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - ensure_all_concrete_serializers_registered - - - - - - .. rubric:: Classes - - .. autosummary:: - - code_dill - code_dill_source - code_pickle - code_text_inspect - pickle_base64 - - - - - - - - - diff --git a/docs/stubs/funcx.utils.errors.FailureResponse.rst b/docs/stubs/funcx.utils.errors.FailureResponse.rst deleted file mode 100644 index 0ac556d3d..000000000 --- a/docs/stubs/funcx.utils.errors.FailureResponse.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.FailureResponse -================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: FailureResponse \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.FuncXUnreachable.rst b/docs/stubs/funcx.utils.errors.FuncXUnreachable.rst deleted file mode 100644 index 178aed298..000000000 --- a/docs/stubs/funcx.utils.errors.FuncXUnreachable.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.FuncXUnreachable -=================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: FuncXUnreachable \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.HTTPError.rst b/docs/stubs/funcx.utils.errors.HTTPError.rst deleted file mode 100644 index 69d668ec2..000000000 --- a/docs/stubs/funcx.utils.errors.HTTPError.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.HTTPError -============================ - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: HTTPError \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.InvalidScopeException.rst b/docs/stubs/funcx.utils.errors.InvalidScopeException.rst deleted file mode 100644 index 70aa74809..000000000 --- a/docs/stubs/funcx.utils.errors.InvalidScopeException.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.InvalidScopeException -======================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: InvalidScopeException \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.MalformedResponse.rst b/docs/stubs/funcx.utils.errors.MalformedResponse.rst deleted file mode 100644 index 872c707d0..000000000 --- a/docs/stubs/funcx.utils.errors.MalformedResponse.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.MalformedResponse -==================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: MalformedResponse \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.MaxResultSizeExceeded.rst b/docs/stubs/funcx.utils.errors.MaxResultSizeExceeded.rst deleted file mode 100644 index b170206ad..000000000 --- a/docs/stubs/funcx.utils.errors.MaxResultSizeExceeded.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.MaxResultSizeExceeded -======================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: MaxResultSizeExceeded \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.RegistrationError.rst b/docs/stubs/funcx.utils.errors.RegistrationError.rst deleted file mode 100644 index f924ec18d..000000000 --- a/docs/stubs/funcx.utils.errors.RegistrationError.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.RegistrationError -==================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: RegistrationError \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.SerializationError.rst b/docs/stubs/funcx.utils.errors.SerializationError.rst deleted file mode 100644 index 4bff7ee69..000000000 --- a/docs/stubs/funcx.utils.errors.SerializationError.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.SerializationError -===================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: SerializationError \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.TaskPending.rst b/docs/stubs/funcx.utils.errors.TaskPending.rst deleted file mode 100644 index c43d0047f..000000000 --- a/docs/stubs/funcx.utils.errors.TaskPending.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.TaskPending -============================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: TaskPending \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.UserCancelledException.rst b/docs/stubs/funcx.utils.errors.UserCancelledException.rst deleted file mode 100644 index fd614ceef..000000000 --- a/docs/stubs/funcx.utils.errors.UserCancelledException.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.UserCancelledException -========================================= - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: UserCancelledException \ No newline at end of file diff --git a/docs/stubs/funcx.utils.errors.VersionMismatch.rst b/docs/stubs/funcx.utils.errors.VersionMismatch.rst deleted file mode 100644 index 57c8e8064..000000000 --- a/docs/stubs/funcx.utils.errors.VersionMismatch.rst +++ /dev/null @@ -1,6 +0,0 @@ -funcx.utils.errors.VersionMismatch -================================== - -.. currentmodule:: funcx.utils.errors - -.. autoexception:: VersionMismatch \ No newline at end of file diff --git a/docs/stubs/funcx_endpoint.endpoint.endpoint.rst b/docs/stubs/funcx_endpoint.endpoint.endpoint.rst deleted file mode 100644 index 7ef21457d..000000000 --- a/docs/stubs/funcx_endpoint.endpoint.endpoint.rst +++ /dev/null @@ -1,38 +0,0 @@ -funcx\_endpoint.endpoint.endpoint -================================= - -.. automodule:: funcx_endpoint.endpoint.endpoint - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - cli_run - complete_endpoint_name - configure_endpoint - delete_endpoint - list_endpoints - main - restart_endpoint - start_endpoint - stop_endpoint - version_callback - - - - - - - - - - - - - diff --git a/docs/stubs/funcx_endpoint.endpoint.endpoint_manager.EndpointManager.rst b/docs/stubs/funcx_endpoint.endpoint.endpoint_manager.EndpointManager.rst deleted file mode 100644 index 66f2361c8..000000000 --- a/docs/stubs/funcx_endpoint.endpoint.endpoint_manager.EndpointManager.rst +++ /dev/null @@ -1,32 +0,0 @@ -funcx\_endpoint.endpoint.endpoint\_manager.EndpointManager -========================================================== - -.. currentmodule:: funcx_endpoint.endpoint.endpoint_manager - -.. autoclass:: EndpointManager - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~EndpointManager.__init__ - ~EndpointManager.check_endpoint_json - ~EndpointManager.check_pidfile - ~EndpointManager.configure_endpoint - ~EndpointManager.daemon_launch - ~EndpointManager.delete_endpoint - ~EndpointManager.init_endpoint - ~EndpointManager.init_endpoint_dir - ~EndpointManager.list_endpoints - ~EndpointManager.pidfile_cleanup - ~EndpointManager.start_endpoint - ~EndpointManager.stop_endpoint - - - - - diff --git a/docs/stubs/funcx_endpoint.endpoint.interchange.EndpointInterchange.rst b/docs/stubs/funcx_endpoint.endpoint.interchange.EndpointInterchange.rst deleted file mode 100644 index 2fb170820..000000000 --- a/docs/stubs/funcx_endpoint.endpoint.interchange.EndpointInterchange.rst +++ /dev/null @@ -1,35 +0,0 @@ -funcx\_endpoint.endpoint.interchange.EndpointInterchange -======================================================== - -.. currentmodule:: funcx_endpoint.endpoint.interchange - -.. autoclass:: EndpointInterchange - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~EndpointInterchange.__init__ - ~EndpointInterchange.apply_reg_info - ~EndpointInterchange.get_container - ~EndpointInterchange.get_status_report - ~EndpointInterchange.handle_sigterm - ~EndpointInterchange.load_config - ~EndpointInterchange.migrate_tasks_to_internal - ~EndpointInterchange.provider_status - ~EndpointInterchange.quiesce - ~EndpointInterchange.register_endpoint - ~EndpointInterchange.scale_in - ~EndpointInterchange.scale_out - ~EndpointInterchange.start - ~EndpointInterchange.start_executors - ~EndpointInterchange.stop - - - - - diff --git a/docs/stubs/funcx_endpoint.endpoint.taskqueue.TaskQueue.rst b/docs/stubs/funcx_endpoint.endpoint.taskqueue.TaskQueue.rst deleted file mode 100644 index 17bceb81a..000000000 --- a/docs/stubs/funcx_endpoint.endpoint.taskqueue.TaskQueue.rst +++ /dev/null @@ -1,29 +0,0 @@ -funcx\_endpoint.endpoint.taskqueue.TaskQueue -============================================ - -.. currentmodule:: funcx_endpoint.endpoint.taskqueue - -.. autoclass:: TaskQueue - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TaskQueue.__init__ - ~TaskQueue.add_client_key - ~TaskQueue.close - ~TaskQueue.get - ~TaskQueue.put - ~TaskQueue.register_client - ~TaskQueue.setup_client_auth - ~TaskQueue.setup_server_auth - ~TaskQueue.zmq_context - - - - - diff --git a/docs/stubs/funcx_endpoint.strategies.base.BaseStrategy.rst b/docs/stubs/funcx_endpoint.strategies.base.BaseStrategy.rst deleted file mode 100644 index 04b5670d3..000000000 --- a/docs/stubs/funcx_endpoint.strategies.base.BaseStrategy.rst +++ /dev/null @@ -1,26 +0,0 @@ -funcx\_endpoint.strategies.base.BaseStrategy -============================================ - -.. currentmodule:: funcx_endpoint.strategies.base - -.. autoclass:: BaseStrategy - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BaseStrategy.__init__ - ~BaseStrategy.close - ~BaseStrategy.make_callback - ~BaseStrategy.notify - ~BaseStrategy.start - ~BaseStrategy.strategize - - - - - diff --git a/docs/stubs/funcx_endpoint.strategies.kube_simple.KubeSimpleStrategy.rst b/docs/stubs/funcx_endpoint.strategies.kube_simple.KubeSimpleStrategy.rst deleted file mode 100644 index cadc29f50..000000000 --- a/docs/stubs/funcx_endpoint.strategies.kube_simple.KubeSimpleStrategy.rst +++ /dev/null @@ -1,26 +0,0 @@ -funcx\_endpoint.strategies.kube\_simple.KubeSimpleStrategy -========================================================== - -.. currentmodule:: funcx_endpoint.strategies.kube_simple - -.. autoclass:: KubeSimpleStrategy - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~KubeSimpleStrategy.__init__ - ~KubeSimpleStrategy.close - ~KubeSimpleStrategy.make_callback - ~KubeSimpleStrategy.notify - ~KubeSimpleStrategy.start - ~KubeSimpleStrategy.strategize - - - - - diff --git a/docs/stubs/funcx_endpoint.strategies.simple.SimpleStrategy.rst b/docs/stubs/funcx_endpoint.strategies.simple.SimpleStrategy.rst deleted file mode 100644 index c86991df1..000000000 --- a/docs/stubs/funcx_endpoint.strategies.simple.SimpleStrategy.rst +++ /dev/null @@ -1,26 +0,0 @@ -funcx\_endpoint.strategies.simple.SimpleStrategy -================================================ - -.. currentmodule:: funcx_endpoint.strategies.simple - -.. autoclass:: SimpleStrategy - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SimpleStrategy.__init__ - ~SimpleStrategy.close - ~SimpleStrategy.make_callback - ~SimpleStrategy.notify - ~SimpleStrategy.start - ~SimpleStrategy.strategize - - - - - diff --git a/funcx_sdk/funcx/__init__.py b/funcx_sdk/funcx/__init__.py index 500ce95f4..94508cf13 100644 --- a/funcx_sdk/funcx/__init__.py +++ b/funcx_sdk/funcx/__init__.py @@ -8,5 +8,6 @@ from funcx.sdk.client import FuncXClient from funcx.sdk.errors import FuncxAPIError +from funcx.sdk.executor import FuncXExecutor -__all__ = ("FuncXClient", "FuncxAPIError") +__all__ = ("FuncXExecutor", "FuncXClient", "FuncxAPIError") diff --git a/funcx_sdk/setup.py b/funcx_sdk/setup.py index 86ef7ab76..2f9380b4d 100644 --- a/funcx_sdk/setup.py +++ b/funcx_sdk/setup.py @@ -17,7 +17,8 @@ "dill==0.3.4", ] DOCS_REQUIRES = [ - "sphinx_rtd_theme", + "sphinx<5", + "furo==2021.09.08", ] TEST_REQUIRES = [