def stop(self, seconds: Optional[Union[float, int]] = None) -> None:
"""Stops the tracked run and kills the synchronization thread.
`.stop()` will be automatically called when a script that created the run finishes or on the destruction
of Neptune context.
When using Neptune with Jupyter notebooks it's a good practice to stop the tracked run manually as it
will be stopped automatically only when the Jupyter kernel stops.
Args:
seconds (int or float, optional): Seconds to wait for all tracking calls to finish
before stopping the tracked run.
If `None` will wait for all tracking calls to finish. Defaults to `True`.
Examples:
If you are creating tracked runs from the script you don't need to call `.stop()`:
>>> import neptune.new as neptune
>>> run = neptune.init()
>>> # Your training or monitoring code
... pass
... # If you are executing Python script .stop()
... # is automatically called at the end for every run
If you are performing multiple training jobs from one script one after the other it is a good practice
to `.stop()` the finished tracked runs as every open run keeps an open connection with Neptune,
monitors hardware usage, etc. You can also use Context Managers - Neptune will automatically call `.stop()`
on the destruction of Run context:
>>> import neptune.new as neptune
>>> # If you are running consecutive training jobs from the same script
... # stop the tracked runs manually at the end of single training job
... for config in configs:
... run = neptune.init()
... # Your training or monitoring code
... pass
... run.stop()
>>> # You can also use with statement and context manager
... for config in configs:
... with neptune.init() as run:
... # Your training or monitoring code
... pass
... # .stop() is automatically called
... # when code execution exits the with statement
.. warning::
If you are using Jupyter notebooks for creating your runs you need to manually invoke `.stop()` once the
training and evaluation is done.
You may also want to check `stop docs page`_.
.. _stop docs page:
https://docs.neptune.ai/api-reference/run#.stop
"""
return AttributeContainer.stop(self, seconds=seconds)
def stop(self, seconds: Optional[Union[float, int]] = None) -> None:
"""Stops the connection to the project and kills the synchronization thread.
`.stop()` will be automatically called when a script that initialized the connection finishes
or on the destruction of Neptune context.
When using Neptune with Jupyter notebooks it's a good practice to stop the connection manually as it
will be stopped automatically only when the Jupyter kernel stops.
Args:
seconds (int or float, optional): Seconds to wait for all tracking calls to finish
before stopping the tracked run.
If `None` will wait for all tracking calls to finish. Defaults to `True`.
Examples:
If you are initializing the connection from a script you don't need to call `.stop()`:
>>> import neptune.new as neptune
>>> project = neptune.init_project(name="MY_WORKSPACE/MY_PROJECT")
>>> # Your code
... pass
... # If you are executing Python script .stop()
... # is automatically called at the end for every Neptune object
If you are initializing multiple connection from one script it is a good practice
to .stop() the unneeded connections. You can also use Context Managers - Neptune
will automatically call .stop() on the destruction of Project context:
>>> import neptune.new as neptune
>>> # If you are initializing multiple connections from the same script
... # stop the connection manually once not needed
... for project_name in projects:
... project = neptune.init_project(name=project_name)
... # Your code
... pass
... project.stop()
>>> # You can also use with statement and context manager
... for project_name in projects:
... with neptune.init_project(name=project_name) as project:
... # Your code
... pass
... # .stop() is automatically called
... # when code execution exits the with statement
.. warning::
If you are using Jupyter notebooks for connecting to a project you need to manually invoke `.stop()`
once the connection is not needed.
You may also want to check `stop docs page`_.
.. _stop docs page:
https://docs.neptune.ai/api-reference/project#.stop
"""
return AttributeContainer.stop(self, seconds=seconds)