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

run_udf: "locally stored UDF"? #225

Closed
soxofaan opened this issue Mar 25, 2021 · 2 comments
Closed

run_udf: "locally stored UDF"? #225

soxofaan opened this issue Mar 25, 2021 · 2 comments
Assignees
Milestone

Comments

@soxofaan
Copy link
Member

from

"description": "Runs an UDF in one of the supported runtime environments.\n\nThe process can either:\n\n1. load and run a locally stored UDF from a file in the workspace of the authenticated user. The path to the UDF file must be relative to the root directory of the user's workspace.\n2. fetch and run a remotely stored and published UDF by absolute URI, for example from [openEO Hub](https://hub.openeo.org)).\n3. run the source code specified inline as string.\n\nThe loaded UDF can be executed in several processes such as ``aggregate_spatial()``, ``apply()``, ``apply_dimension()`` and ``reduce_dimension()``. In this case an array is passed instead of a raster data cube. The user must ensure that the data is properly passed as an array so that the UDF can make sense of it.",
:

The process can either:

   1. load and run a locally stored UDF from a file in the workspace of the authenticated user. The path to the UDF file must be relative to the root directory of the user's workspace.

The use of "locally" and "workspace" is quite confusing here I think. This read like the user can work with a UDF file locally on their laptop/computer, and just send the (relative) path, which makes no sense

"workspace" is also quite ambiguous in this context: it could also be interpreted as the "work environment" the user is working in (e.g. local laptop or a remotely hosted jupyter notebook).

I think we have to find a more precise name for "workspace" to avoid ambiguity in these kind of docs. e.g.: "backend workspace"?

@m-mohr
Copy link
Member

m-mohr commented Apr 12, 2021

Ouch, I meant to make a PR, but accidentally pushed to the wrong branch.

@soxofaan Could you please verify that commit 3f3460e works better for you?

@m-mohr m-mohr added this to the 1.1.0 milestone Apr 12, 2021
@soxofaan
Copy link
Member Author

yes, the explicit "server-side user workspace" leaves no room for ambiguity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants