modal 1.0.5.dev3__py3-none-any.whl → 1.0.5.dev5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
modal/_functions.py CHANGED
@@ -1671,8 +1671,9 @@ Use the `Function.get_web_url()` method instead.
1671
1671
  async def spawn(self, *args: P.args, **kwargs: P.kwargs) -> "_FunctionCall[ReturnType]":
1672
1672
  """Calls the function with the given arguments, without waiting for the results.
1673
1673
 
1674
- Returns a [`modal.FunctionCall`](/docs/reference/modal.FunctionCall) object, that can later be polled or
1675
- waited for using [`.get(timeout=...)`](/docs/reference/modal.FunctionCall#get).
1674
+ Returns a [`modal.FunctionCall`](https://modal.com/docs/reference/modal.FunctionCall) object
1675
+ that can later be polled or waited for using
1676
+ [`.get(timeout=...)`](https://modal.com/docs/reference/modal.FunctionCall#get).
1676
1677
  Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
1677
1678
  """
1678
1679
  self._check_no_web_url("spawn")
@@ -1748,7 +1749,7 @@ class _FunctionCall(typing.Generic[ReturnType], _Object, type_prefix="fc"):
1748
1749
  """Returns a structure representing the call graph from a given root
1749
1750
  call ID, along with the status of execution for each node.
1750
1751
 
1751
- See [`modal.call_graph`](/docs/reference/modal.call_graph) reference page
1752
+ See [`modal.call_graph`](https://modal.com/docs/reference/modal.call_graph) reference page
1752
1753
  for documentation on the structure of the returned `InputInfo` items.
1753
1754
  """
1754
1755
  assert self._client and self._client.stub
@@ -1762,7 +1763,7 @@ class _FunctionCall(typing.Generic[ReturnType], _Object, type_prefix="fc"):
1762
1763
  terminate_containers: bool = False,
1763
1764
  ):
1764
1765
  """Cancels the function call, which will stop its execution and mark its inputs as
1765
- [`TERMINATED`](/docs/reference/modal.call_graph#modalcall_graphinputstatus).
1766
+ [`TERMINATED`](https://modal.com/docs/reference/modal.call_graph#modalcall_graphinputstatus).
1766
1767
 
1767
1768
  If `terminate_containers=True` - the containers running the cancelled inputs are all terminated
1768
1769
  causing any non-cancelled inputs on those containers to be rescheduled in new containers.
@@ -538,7 +538,7 @@ def _wsgi_app(
538
538
  Web Server Gateway Interface (WSGI) is a standard for synchronous Python web apps.
539
539
  It has been [succeeded by the ASGI interface](https://asgi.readthedocs.io/en/latest/introduction.html#wsgi-compatibility)
540
540
  which is compatible with ASGI and supports additional functionality such as web sockets.
541
- Modal supports ASGI via [`asgi_app`](/docs/reference/modal.asgi_app).
541
+ Modal supports ASGI via [`asgi_app`](https://modal.com/docs/reference/modal.asgi_app).
542
542
 
543
543
  **Usage:**
544
544
 
modal/app.py CHANGED
@@ -550,8 +550,8 @@ class _App:
550
550
  modal run app_module.py
551
551
  ```
552
552
 
553
- Note that an explicit [`app.run()`](/docs/reference/modal.App#run) is not needed, as an
554
- [app](/docs/guide/apps) is automatically created for you.
553
+ Note that an explicit [`app.run()`](https://modal.com/docs/reference/modal.App#run) is not needed, as an
554
+ [app](https://modal.com/docs/guide/apps) is automatically created for you.
555
555
 
556
556
  **Multiple Entrypoints**
557
557
 
@@ -657,7 +657,7 @@ class _App:
657
657
  _experimental_buffer_containers: Optional[int] = None, # Now stable API with `buffer_containers`
658
658
  allow_cross_region_volumes: Optional[bool] = None, # Always True on the Modal backend now
659
659
  ) -> _FunctionDecoratorType:
660
- """Decorator to register a new Modal [Function](/docs/reference/modal.Function) with this App."""
660
+ """Decorator to register a new Modal Function with this App."""
661
661
  if isinstance(_warn_parentheses_missing, _Image):
662
662
  # Handle edge case where maybe (?) some users passed image as a positional arg
663
663
  raise InvalidError("`image` needs to be a keyword argument: `@app.function(image=image)`.")
@@ -881,7 +881,7 @@ class _App:
881
881
  allow_cross_region_volumes: Optional[bool] = None, # Always True on the Modal backend now
882
882
  ) -> Callable[[Union[CLS_T, _PartialFunction]], CLS_T]:
883
883
  """
884
- Decorator to register a new Modal [Cls](/docs/reference/modal.Cls) with this App.
884
+ Decorator to register a new Modal [Cls](https://modal.com/docs/reference/modal.Cls) with this App.
885
885
  """
886
886
  if _warn_parentheses_missing:
887
887
  raise InvalidError("Did you forget parentheses? Suggestion: `@app.cls()`.")
modal/app.pyi CHANGED
@@ -341,8 +341,8 @@ class _App:
341
341
  modal run app_module.py
342
342
  ```
343
343
 
344
- Note that an explicit [`app.run()`](/docs/reference/modal.App#run) is not needed, as an
345
- [app](/docs/guide/apps) is automatically created for you.
344
+ Note that an explicit [`app.run()`](https://modal.com/docs/reference/modal.App#run) is not needed, as an
345
+ [app](https://modal.com/docs/guide/apps) is automatically created for you.
346
346
 
347
347
  **Multiple Entrypoints**
348
348
 
@@ -417,7 +417,7 @@ class _App:
417
417
  _experimental_buffer_containers: typing.Optional[int] = None,
418
418
  allow_cross_region_volumes: typing.Optional[bool] = None,
419
419
  ) -> _FunctionDecoratorType:
420
- """Decorator to register a new Modal [Function](/docs/reference/modal.Function) with this App."""
420
+ """Decorator to register a new Modal Function with this App."""
421
421
  ...
422
422
 
423
423
  @typing_extensions.dataclass_transform(
@@ -468,7 +468,7 @@ class _App:
468
468
  _experimental_buffer_containers: typing.Optional[int] = None,
469
469
  allow_cross_region_volumes: typing.Optional[bool] = None,
470
470
  ) -> collections.abc.Callable[[typing.Union[CLS_T, modal._partial_function._PartialFunction]], CLS_T]:
471
- """Decorator to register a new Modal [Cls](/docs/reference/modal.Cls) with this App."""
471
+ """Decorator to register a new Modal [Cls](https://modal.com/docs/reference/modal.Cls) with this App."""
472
472
  ...
473
473
 
474
474
  def include(self, /, other_app: _App) -> typing_extensions.Self:
@@ -929,8 +929,8 @@ class App:
929
929
  modal run app_module.py
930
930
  ```
931
931
 
932
- Note that an explicit [`app.run()`](/docs/reference/modal.App#run) is not needed, as an
933
- [app](/docs/guide/apps) is automatically created for you.
932
+ Note that an explicit [`app.run()`](https://modal.com/docs/reference/modal.App#run) is not needed, as an
933
+ [app](https://modal.com/docs/guide/apps) is automatically created for you.
934
934
 
935
935
  **Multiple Entrypoints**
936
936
 
@@ -1005,7 +1005,7 @@ class App:
1005
1005
  _experimental_buffer_containers: typing.Optional[int] = None,
1006
1006
  allow_cross_region_volumes: typing.Optional[bool] = None,
1007
1007
  ) -> _FunctionDecoratorType:
1008
- """Decorator to register a new Modal [Function](/docs/reference/modal.Function) with this App."""
1008
+ """Decorator to register a new Modal Function with this App."""
1009
1009
  ...
1010
1010
 
1011
1011
  @typing_extensions.dataclass_transform(
@@ -1056,7 +1056,7 @@ class App:
1056
1056
  _experimental_buffer_containers: typing.Optional[int] = None,
1057
1057
  allow_cross_region_volumes: typing.Optional[bool] = None,
1058
1058
  ) -> collections.abc.Callable[[typing.Union[CLS_T, modal.partial_function.PartialFunction]], CLS_T]:
1059
- """Decorator to register a new Modal [Cls](/docs/reference/modal.Cls) with this App."""
1059
+ """Decorator to register a new Modal [Cls](https://modal.com/docs/reference/modal.Cls) with this App."""
1060
1060
  ...
1061
1061
 
1062
1062
  def include(self, /, other_app: App) -> typing_extensions.Self:
modal/cli/run.py CHANGED
@@ -579,7 +579,8 @@ def shell(
579
579
  modal shell hello_world.py::my_function
580
580
  ```
581
581
 
582
- Or, if you're using a [modal.Cls](/docs/reference/modal.Cls), you can refer to a `@modal.method` directly:
582
+ Or, if you're using a [modal.Cls](https://modal.com/docs/reference/modal.Cls)
583
+ you can refer to a `@modal.method` directly:
583
584
 
584
585
  ```
585
586
  modal shell hello_world.py::MyClass.my_method
modal/client.pyi CHANGED
@@ -31,7 +31,7 @@ class _Client:
31
31
  server_url: str,
32
32
  client_type: int,
33
33
  credentials: typing.Optional[tuple[str, str]],
34
- version: str = "1.0.5.dev3",
34
+ version: str = "1.0.5.dev5",
35
35
  ):
36
36
  """mdmd:hidden
37
37
  The Modal client object is not intended to be instantiated directly by users.
@@ -160,7 +160,7 @@ class Client:
160
160
  server_url: str,
161
161
  client_type: int,
162
162
  credentials: typing.Optional[tuple[str, str]],
163
- version: str = "1.0.5.dev3",
163
+ version: str = "1.0.5.dev5",
164
164
  ):
165
165
  """mdmd:hidden
166
166
  The Modal client object is not intended to be instantiated directly by users.
modal/cls.py CHANGED
@@ -438,11 +438,11 @@ Obj = synchronize_api(_Obj)
438
438
 
439
439
  class _Cls(_Object, type_prefix="cs"):
440
440
  """
441
- Cls adds method pooling and [lifecycle hook](/docs/guide/lifecycle-functions) behavior
442
- to [modal.Function](/docs/reference/modal.Function).
441
+ Cls adds method pooling and [lifecycle hook](https://modal.com/docs/guide/lifecycle-functions) behavior
442
+ to [modal.Function](https://modal.com/docs/reference/modal.Function).
443
443
 
444
444
  Generally, you will not construct a Cls directly.
445
- Instead, use the [`@app.cls()`](/docs/reference/modal.App#cls) decorator on the App object.
445
+ Instead, use the [`@app.cls()`](https://modal.com/docs/reference/modal.App#cls) decorator on the App object.
446
446
  """
447
447
 
448
448
  _class_service_function: Optional[_Function] # The _Function (read "service") serving *all* methods of the class
modal/cls.pyi CHANGED
@@ -326,11 +326,11 @@ class Obj:
326
326
  def __getattr__(self, k): ...
327
327
 
328
328
  class _Cls(modal._object._Object):
329
- """Cls adds method pooling and [lifecycle hook](/docs/guide/lifecycle-functions) behavior
330
- to [modal.Function](/docs/reference/modal.Function).
329
+ """Cls adds method pooling and [lifecycle hook](https://modal.com/docs/guide/lifecycle-functions) behavior
330
+ to [modal.Function](https://modal.com/docs/reference/modal.Function).
331
331
 
332
332
  Generally, you will not construct a Cls directly.
333
- Instead, use the [`@app.cls()`](/docs/reference/modal.App#cls) decorator on the App object.
333
+ Instead, use the [`@app.cls()`](https://modal.com/docs/reference/modal.App#cls) decorator on the App object.
334
334
  """
335
335
 
336
336
  _class_service_function: typing.Optional[modal._functions._Function]
@@ -481,11 +481,11 @@ class _Cls(modal._object._Object):
481
481
  def _is_local(self) -> bool: ...
482
482
 
483
483
  class Cls(modal.object.Object):
484
- """Cls adds method pooling and [lifecycle hook](/docs/guide/lifecycle-functions) behavior
485
- to [modal.Function](/docs/reference/modal.Function).
484
+ """Cls adds method pooling and [lifecycle hook](https://modal.com/docs/guide/lifecycle-functions) behavior
485
+ to [modal.Function](https://modal.com/docs/reference/modal.Function).
486
486
 
487
487
  Generally, you will not construct a Cls directly.
488
- Instead, use the [`@app.cls()`](/docs/reference/modal.App#cls) decorator on the App object.
488
+ Instead, use the [`@app.cls()`](https://modal.com/docs/reference/modal.App#cls) decorator on the App object.
489
489
  """
490
490
 
491
491
  _class_service_function: typing.Optional[modal.functions.Function]
modal/dict.py CHANGED
@@ -62,7 +62,7 @@ class _Dict(_Object, type_prefix="di"):
62
62
  the `.aio` suffix on the method, whereas their operator-based analogues will always
63
63
  run synchronously and block the event loop.
64
64
 
65
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-dicts).
65
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
66
66
  """
67
67
 
68
68
  def __init__(self, data={}):
modal/dict.pyi CHANGED
@@ -47,7 +47,7 @@ class _Dict(modal._object._Object):
47
47
  the `.aio` suffix on the method, whereas their operator-based analogues will always
48
48
  run synchronously and block the event loop.
49
49
 
50
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-dicts).
50
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
51
51
  """
52
52
  def __init__(self, data={}):
53
53
  """mdmd:hidden"""
@@ -262,7 +262,7 @@ class Dict(modal.object.Object):
262
262
  the `.aio` suffix on the method, whereas their operator-based analogues will always
263
263
  run synchronously and block the event loop.
264
264
 
265
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-dicts).
265
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-dicts).
266
266
  """
267
267
  def __init__(self, data={}):
268
268
  """mdmd:hidden"""
modal/exception.py CHANGED
@@ -9,8 +9,8 @@ UserCodeException = synchronicity.exceptions.UserCodeException # Deprecated typ
9
9
 
10
10
  class Error(Exception):
11
11
  """
12
- Base class for all Modal errors. See [`modal.exception`](/docs/reference/modal.exception) for the specialized
13
- error classes.
12
+ Base class for all Modal errors. See [`modal.exception`](https://modal.com/docs/reference/modal.exception)
13
+ for the specialized error classes.
14
14
 
15
15
  **Usage**
16
16
 
modal/functions.pyi CHANGED
@@ -501,8 +501,9 @@ class Function(
501
501
  def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
502
502
  """Calls the function with the given arguments, without waiting for the results.
503
503
 
504
- Returns a [`modal.FunctionCall`](/docs/reference/modal.FunctionCall) object, that can later be polled or
505
- waited for using [`.get(timeout=...)`](/docs/reference/modal.FunctionCall#get).
504
+ Returns a [`modal.FunctionCall`](https://modal.com/docs/reference/modal.FunctionCall) object
505
+ that can later be polled or waited for using
506
+ [`.get(timeout=...)`](https://modal.com/docs/reference/modal.FunctionCall#get).
506
507
  Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
507
508
  """
508
509
  ...
@@ -510,8 +511,9 @@ class Function(
510
511
  async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
511
512
  """Calls the function with the given arguments, without waiting for the results.
512
513
 
513
- Returns a [`modal.FunctionCall`](/docs/reference/modal.FunctionCall) object, that can later be polled or
514
- waited for using [`.get(timeout=...)`](/docs/reference/modal.FunctionCall#get).
514
+ Returns a [`modal.FunctionCall`](https://modal.com/docs/reference/modal.FunctionCall) object
515
+ that can later be polled or waited for using
516
+ [`.get(timeout=...)`](https://modal.com/docs/reference/modal.FunctionCall#get).
515
517
  Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
516
518
  """
517
519
  ...
@@ -741,7 +743,7 @@ class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Obj
741
743
  """Returns a structure representing the call graph from a given root
742
744
  call ID, along with the status of execution for each node.
743
745
 
744
- See [`modal.call_graph`](/docs/reference/modal.call_graph) reference page
746
+ See [`modal.call_graph`](https://modal.com/docs/reference/modal.call_graph) reference page
745
747
  for documentation on the structure of the returned `InputInfo` items.
746
748
  """
747
749
  ...
@@ -750,7 +752,7 @@ class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Obj
750
752
  """Returns a structure representing the call graph from a given root
751
753
  call ID, along with the status of execution for each node.
752
754
 
753
- See [`modal.call_graph`](/docs/reference/modal.call_graph) reference page
755
+ See [`modal.call_graph`](https://modal.com/docs/reference/modal.call_graph) reference page
754
756
  for documentation on the structure of the returned `InputInfo` items.
755
757
  """
756
758
  ...
@@ -760,7 +762,7 @@ class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Obj
760
762
  class __cancel_spec(typing_extensions.Protocol[SUPERSELF]):
761
763
  def __call__(self, /, terminate_containers: bool = False):
762
764
  """Cancels the function call, which will stop its execution and mark its inputs as
763
- [`TERMINATED`](/docs/reference/modal.call_graph#modalcall_graphinputstatus).
765
+ [`TERMINATED`](https://modal.com/docs/reference/modal.call_graph#modalcall_graphinputstatus).
764
766
 
765
767
  If `terminate_containers=True` - the containers running the cancelled inputs are all terminated
766
768
  causing any non-cancelled inputs on those containers to be rescheduled in new containers.
@@ -769,7 +771,7 @@ class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Obj
769
771
 
770
772
  async def aio(self, /, terminate_containers: bool = False):
771
773
  """Cancels the function call, which will stop its execution and mark its inputs as
772
- [`TERMINATED`](/docs/reference/modal.call_graph#modalcall_graphinputstatus).
774
+ [`TERMINATED`](https://modal.com/docs/reference/modal.call_graph#modalcall_graphinputstatus).
773
775
 
774
776
  If `terminate_containers=True` - the containers running the cancelled inputs are all terminated
775
777
  causing any non-cancelled inputs on those containers to be rescheduled in new containers.
modal/gpu.py CHANGED
@@ -166,7 +166,7 @@ __doc__ = """
166
166
  **GPU configuration shortcodes**
167
167
 
168
168
  You can pass a wide range of `str` values for the `gpu` parameter of
169
- [`@app.function`](/docs/reference/modal.App#function).
169
+ [`@app.function`](https://modal.com/docs/reference/modal.App#function).
170
170
 
171
171
  For instance:
172
172
  - `gpu="H100"` will attach 1 H100 GPU to each container
modal/image.py CHANGED
@@ -1623,7 +1623,7 @@ class _Image(_Object, type_prefix="im"):
1623
1623
  """Build a Modal image from a private image in Google Cloud Platform (GCP) Artifact Registry.
1624
1624
 
1625
1625
  You will need to pass a `modal.Secret` containing [your GCP service account key data](https://cloud.google.com/iam/docs/keys-create-delete#creating)
1626
- as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](/secrets) page.
1626
+ as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](https://modal.com/secrets) page.
1627
1627
  Your service account should be granted a specific role depending on the GCP registry used:
1628
1628
 
1629
1629
  - For Artifact Registry images (`pkg.dev` domains) use
modal/image.pyi CHANGED
@@ -677,7 +677,7 @@ class _Image(modal._object._Object):
677
677
  """Build a Modal image from a private image in Google Cloud Platform (GCP) Artifact Registry.
678
678
 
679
679
  You will need to pass a `modal.Secret` containing [your GCP service account key data](https://cloud.google.com/iam/docs/keys-create-delete#creating)
680
- as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](/secrets) page.
680
+ as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](https://modal.com/secrets) page.
681
681
  Your service account should be granted a specific role depending on the GCP registry used:
682
682
 
683
683
  - For Artifact Registry images (`pkg.dev` domains) use
@@ -1513,7 +1513,7 @@ class Image(modal.object.Object):
1513
1513
  """Build a Modal image from a private image in Google Cloud Platform (GCP) Artifact Registry.
1514
1514
 
1515
1515
  You will need to pass a `modal.Secret` containing [your GCP service account key data](https://cloud.google.com/iam/docs/keys-create-delete#creating)
1516
- as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](/secrets) page.
1516
+ as `SERVICE_ACCOUNT_JSON`. This can be done from the [Secrets](https://modal.com/secrets) page.
1517
1517
  Your service account should be granted a specific role depending on the GCP registry used:
1518
1518
 
1519
1519
  - For Artifact Registry images (`pkg.dev` domains) use
@@ -206,7 +206,7 @@ def wsgi_app(
206
206
  Web Server Gateway Interface (WSGI) is a standard for synchronous Python web apps.
207
207
  It has been [succeeded by the ASGI interface](https://asgi.readthedocs.io/en/latest/introduction.html#wsgi-compatibility)
208
208
  which is compatible with ASGI and supports additional functionality such as web sockets.
209
- Modal supports ASGI via [`asgi_app`](/docs/reference/modal.asgi_app).
209
+ Modal supports ASGI via [`asgi_app`](https://modal.com/docs/reference/modal.asgi_app).
210
210
 
211
211
  **Usage:**
212
212
 
modal/proxy.py CHANGED
@@ -12,7 +12,7 @@ class _Proxy(_Object, type_prefix="pr"):
12
12
  """Proxy objects give your Modal containers a static outbound IP address.
13
13
 
14
14
  This can be used for connecting to a remote address with network whitelist, for example
15
- a database. See [the guide](/docs/guide/proxy-ips) for more information.
15
+ a database. See [the guide](https://modal.com/docs/guide/proxy-ips) for more information.
16
16
  """
17
17
 
18
18
  @staticmethod
modal/proxy.pyi CHANGED
@@ -6,7 +6,7 @@ class _Proxy(modal._object._Object):
6
6
  """Proxy objects give your Modal containers a static outbound IP address.
7
7
 
8
8
  This can be used for connecting to a remote address with network whitelist, for example
9
- a database. See [the guide](/docs/guide/proxy-ips) for more information.
9
+ a database. See [the guide](https://modal.com/docs/guide/proxy-ips) for more information.
10
10
  """
11
11
  @staticmethod
12
12
  def from_name(name: str, *, environment_name: typing.Optional[str] = None) -> _Proxy:
@@ -21,7 +21,7 @@ class Proxy(modal.object.Object):
21
21
  """Proxy objects give your Modal containers a static outbound IP address.
22
22
 
23
23
  This can be used for connecting to a remote address with network whitelist, for example
24
- a database. See [the guide](/docs/guide/proxy-ips) for more information.
24
+ a database. See [the guide](https://modal.com/docs/guide/proxy-ips) for more information.
25
25
  """
26
26
  def __init__(self, *args, **kwargs):
27
27
  """mdmd:hidden"""
modal/queue.py CHANGED
@@ -64,7 +64,7 @@ class _Queue(_Object, type_prefix="qu"):
64
64
  assert queue.get() == 42
65
65
  ```
66
66
 
67
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-queues).
67
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-queues).
68
68
 
69
69
  **Queue partitions (beta)**
70
70
 
modal/queue.pyi CHANGED
@@ -49,7 +49,7 @@ class _Queue(modal._object._Object):
49
49
  assert queue.get() == 42
50
50
  ```
51
51
 
52
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-queues).
52
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-queues).
53
53
 
54
54
  **Queue partitions (beta)**
55
55
 
@@ -306,7 +306,7 @@ class Queue(modal.object.Object):
306
306
  assert queue.get() == 42
307
307
  ```
308
308
 
309
- For more examples, see the [guide](/docs/guide/dicts-and-queues#modal-queues).
309
+ For more examples, see the [guide](https://modal.com/docs/guide/dicts-and-queues#modal-queues).
310
310
 
311
311
  **Queue partitions (beta)**
312
312
 
modal/sandbox.py CHANGED
@@ -70,7 +70,7 @@ class _Sandbox(_Object, type_prefix="sb"):
70
70
  """A `Sandbox` object lets you interact with a running sandbox. This API is similar to Python's
71
71
  [asyncio.subprocess.Process](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process).
72
72
 
73
- Refer to the [guide](/docs/guide/sandbox) on how to spawn and use sandboxes.
73
+ Refer to the [guide](https://modal.com/docs/guide/sandbox) on how to spawn and use sandboxes.
74
74
  """
75
75
 
76
76
  _result: Optional[api_pb2.GenericResult]
@@ -516,7 +516,7 @@ class _Sandbox(_Object, type_prefix="sb"):
516
516
 
517
517
  Returns a dictionary of `Tunnel` objects which are keyed by the container port.
518
518
 
519
- NOTE: Previous to client [v0.64.153](/docs/reference/changelog#064153-2024-09-30), this
519
+ NOTE: Previous to client [v0.64.153](https://modal.com/docs/reference/changelog#064153-2024-09-30), this
520
520
  returned a list of `TunnelData` objects.
521
521
  """
522
522
 
@@ -617,7 +617,7 @@ class _Sandbox(_Object, type_prefix="sb"):
617
617
  ):
618
618
  """Execute a command in the Sandbox and return a ContainerProcess handle.
619
619
 
620
- See the [`ContainerProcess`](/docs/reference/modal.container_process#modalcontainer_processcontainerprocess)
620
+ See the [`ContainerProcess`](https://modal.com/docs/reference/modal.container_process#modalcontainer_processcontainerprocess)
621
621
  docs for more information.
622
622
 
623
623
  **Usage**
@@ -722,7 +722,7 @@ class _Sandbox(_Object, type_prefix="sb"):
722
722
  ):
723
723
  """Open a file in the Sandbox and return a FileIO handle.
724
724
 
725
- See the [`FileIO`](/docs/reference/modal.file_io#modalfile_iofileio) docs for more information.
725
+ See the [`FileIO`](https://modal.com/docs/reference/modal.file_io#modalfile_iofileio) docs for more information.
726
726
 
727
727
  **Usage**
728
728
 
@@ -766,7 +766,7 @@ class _Sandbox(_Object, type_prefix="sb"):
766
766
  @property
767
767
  def stdout(self) -> _StreamReader[str]:
768
768
  """
769
- [`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
769
+ [`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
770
770
  the sandbox's stdout stream.
771
771
  """
772
772
 
@@ -774,7 +774,7 @@ class _Sandbox(_Object, type_prefix="sb"):
774
774
 
775
775
  @property
776
776
  def stderr(self) -> _StreamReader[str]:
777
- """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
777
+ """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
778
778
  the Sandbox's stderr stream.
779
779
  """
780
780
 
@@ -783,7 +783,7 @@ class _Sandbox(_Object, type_prefix="sb"):
783
783
  @property
784
784
  def stdin(self) -> _StreamWriter:
785
785
  """
786
- [`StreamWriter`](/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
786
+ [`StreamWriter`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
787
787
  the Sandbox's stdin stream.
788
788
  """
789
789
 
modal/sandbox.pyi CHANGED
@@ -31,7 +31,7 @@ class _Sandbox(modal._object._Object):
31
31
  """A `Sandbox` object lets you interact with a running sandbox. This API is similar to Python's
32
32
  [asyncio.subprocess.Process](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process).
33
33
 
34
- Refer to the [guide](/docs/guide/sandbox) on how to spawn and use sandboxes.
34
+ Refer to the [guide](https://modal.com/docs/guide/sandbox) on how to spawn and use sandboxes.
35
35
  """
36
36
 
37
37
  _result: typing.Optional[modal_proto.api_pb2.GenericResult]
@@ -183,7 +183,7 @@ class _Sandbox(modal._object._Object):
183
183
 
184
184
  Returns a dictionary of `Tunnel` objects which are keyed by the container port.
185
185
 
186
- NOTE: Previous to client [v0.64.153](/docs/reference/changelog#064153-2024-09-30), this
186
+ NOTE: Previous to client [v0.64.153](https://modal.com/docs/reference/changelog#064153-2024-09-30), this
187
187
  returned a list of `TunnelData` objects.
188
188
  """
189
189
  ...
@@ -264,21 +264,21 @@ class _Sandbox(modal._object._Object):
264
264
 
265
265
  @property
266
266
  def stdout(self) -> modal.io_streams._StreamReader[str]:
267
- """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
267
+ """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
268
268
  the sandbox's stdout stream.
269
269
  """
270
270
  ...
271
271
 
272
272
  @property
273
273
  def stderr(self) -> modal.io_streams._StreamReader[str]:
274
- """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
274
+ """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
275
275
  the Sandbox's stderr stream.
276
276
  """
277
277
  ...
278
278
 
279
279
  @property
280
280
  def stdin(self) -> modal.io_streams._StreamWriter:
281
- """[`StreamWriter`](/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
281
+ """[`StreamWriter`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
282
282
  the Sandbox's stdin stream.
283
283
  """
284
284
  ...
@@ -306,7 +306,7 @@ class Sandbox(modal.object.Object):
306
306
  """A `Sandbox` object lets you interact with a running sandbox. This API is similar to Python's
307
307
  [asyncio.subprocess.Process](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process).
308
308
 
309
- Refer to the [guide](/docs/guide/sandbox) on how to spawn and use sandboxes.
309
+ Refer to the [guide](https://modal.com/docs/guide/sandbox) on how to spawn and use sandboxes.
310
310
  """
311
311
 
312
312
  _result: typing.Optional[modal_proto.api_pb2.GenericResult]
@@ -593,7 +593,7 @@ class Sandbox(modal.object.Object):
593
593
 
594
594
  Returns a dictionary of `Tunnel` objects which are keyed by the container port.
595
595
 
596
- NOTE: Previous to client [v0.64.153](/docs/reference/changelog#064153-2024-09-30), this
596
+ NOTE: Previous to client [v0.64.153](https://modal.com/docs/reference/changelog#064153-2024-09-30), this
597
597
  returned a list of `TunnelData` objects.
598
598
  """
599
599
  ...
@@ -605,7 +605,7 @@ class Sandbox(modal.object.Object):
605
605
 
606
606
  Returns a dictionary of `Tunnel` objects which are keyed by the container port.
607
607
 
608
- NOTE: Previous to client [v0.64.153](/docs/reference/changelog#064153-2024-09-30), this
608
+ NOTE: Previous to client [v0.64.153](https://modal.com/docs/reference/changelog#064153-2024-09-30), this
609
609
  returned a list of `TunnelData` objects.
610
610
  """
611
611
  ...
@@ -804,21 +804,21 @@ class Sandbox(modal.object.Object):
804
804
 
805
805
  @property
806
806
  def stdout(self) -> modal.io_streams.StreamReader[str]:
807
- """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
807
+ """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
808
808
  the sandbox's stdout stream.
809
809
  """
810
810
  ...
811
811
 
812
812
  @property
813
813
  def stderr(self) -> modal.io_streams.StreamReader[str]:
814
- """[`StreamReader`](/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
814
+ """[`StreamReader`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamreader) for
815
815
  the Sandbox's stderr stream.
816
816
  """
817
817
  ...
818
818
 
819
819
  @property
820
820
  def stdin(self) -> modal.io_streams.StreamWriter:
821
- """[`StreamWriter`](/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
821
+ """[`StreamWriter`](https://modal.com/docs/reference/modal.io_streams#modalio_streamsstreamwriter) for
822
822
  the Sandbox's stdin stream.
823
823
  """
824
824
  ...
modal/schedule.py CHANGED
@@ -13,7 +13,7 @@ class Cron(Schedule):
13
13
  """Cron jobs are a type of schedule, specified using the
14
14
  [Unix cron tab](https://crontab.guru/) syntax.
15
15
 
16
- The alternative schedule type is the [`modal.Period`](/docs/reference/modal.Period).
16
+ The alternative schedule type is the [`modal.Period`](https://modal.com/docs/reference/modal.Period).
17
17
 
18
18
  **Usage**
19
19
 
modal/secret.py CHANGED
@@ -24,9 +24,9 @@ class _Secret(_Object, type_prefix="st"):
24
24
 
25
25
  Secrets are a secure way to add credentials and other sensitive information
26
26
  to the containers your functions run in. You can create and edit secrets on
27
- [the dashboard](/secrets), or programmatically from Python code.
27
+ [the dashboard](https://modal.com/secrets), or programmatically from Python code.
28
28
 
29
- See [the secrets guide page](/docs/guide/secrets) for more information.
29
+ See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
30
30
  """
31
31
 
32
32
  @staticmethod
modal/secret.pyi CHANGED
@@ -9,9 +9,9 @@ class _Secret(modal._object._Object):
9
9
 
10
10
  Secrets are a secure way to add credentials and other sensitive information
11
11
  to the containers your functions run in. You can create and edit secrets on
12
- [the dashboard](/secrets), or programmatically from Python code.
12
+ [the dashboard](https://modal.com/secrets), or programmatically from Python code.
13
13
 
14
- See [the secrets guide page](/docs/guide/secrets) for more information.
14
+ See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
15
15
  """
16
16
  @staticmethod
17
17
  def from_dict(env_dict: dict[str, typing.Optional[str]] = {}) -> _Secret:
@@ -109,9 +109,9 @@ class Secret(modal.object.Object):
109
109
 
110
110
  Secrets are a secure way to add credentials and other sensitive information
111
111
  to the containers your functions run in. You can create and edit secrets on
112
- [the dashboard](/secrets), or programmatically from Python code.
112
+ [the dashboard](https://modal.com/secrets), or programmatically from Python code.
113
113
 
114
- See [the secrets guide page](/docs/guide/secrets) for more information.
114
+ See [the secrets guide page](https://modal.com/docs/guide/secrets) for more information.
115
115
  """
116
116
  def __init__(self, *args, **kwargs):
117
117
  """mdmd:hidden"""
modal/volume.py CHANGED
@@ -405,7 +405,7 @@ class _Volume(_Object, type_prefix="vo"):
405
405
 
406
406
  Note - this function is primarily intended to be used outside of a Modal App.
407
407
  For more information on downloading files from a Modal Volume, see
408
- [the guide](/docs/guide/volumes).
408
+ [the guide](https://modal.com/docs/guide/volumes).
409
409
 
410
410
  **Example:**
411
411