nerfbaselines.backends

class nerfbaselines.backends.ApptainerBackend(spec: ApptainerBackendSpec)[source]

Bases: RemoteProcessRPCBackend

install()[source]
name = 'apptainer'
shell(args=None)[source]
class nerfbaselines.backends.ApptainerBackendSpec[source]

Bases: TypedDict

conda_spec: CondaBackendSpec | None
default_cuda_archs: str
environment_name: Required[str]
home_path: str
image: str | None
python_path: str
class nerfbaselines.backends.Backend[source]

Bases: object

install()[source]
instance_call(instance: int, method: str, *args, **kwargs)[source]
instance_del(instance: int)[source]
name = 'unknown'
shell(args: Tuple[str, ...] | None = None)[source]
static_call(function: str, *args, **kwargs)[source]
class nerfbaselines.backends.CondaBackend(spec: CondaBackendSpec)[source]

Bases: RemoteProcessRPCBackend

install()[source]
name = 'conda'
shell(args=None)[source]
class nerfbaselines.backends.CondaBackendSpec[source]

Bases: TypedDict

environment_name: Required[str]
install_script: str | None
python_version: str | None
class nerfbaselines.backends.DockerBackend(spec: DockerBackendSpec)[source]

Bases: RemoteProcessRPCBackend

install()[source]
name = 'docker'
shell(args=None)[source]
class nerfbaselines.backends.DockerBackendSpec[source]

Bases: TypedDict

build_script: str
conda_spec: CondaBackendSpec
default_cuda_archs: str
environment_name: Required[str]
home_path: str
image: str | None
python_path: str
replace_user: bool
class nerfbaselines.backends.SimpleBackend[source]

Bases: Backend

instance_call(instance: int, method: str, *args, **kwargs)[source]
instance_del(instance: int)[source]
name = 'python'
static_call(function: str, *args, **kwargs)[source]
nerfbaselines.backends.forward_port(ps: int, pd: int)[source]
nerfbaselines.backends.get_backend(method_spec: MethodSpec, backend: str | None) Backend[source]
nerfbaselines.backends.get_forwarded_ports()[source]
nerfbaselines.backends.get_implemented_backends(method_spec: MethodSpec) Sequence[Literal['conda', 'docker', 'apptainer', 'python']][source]
nerfbaselines.backends.get_mounts()[source]
nerfbaselines.backends.mount(ps: str | Path, pd: str | Path)[source]
nerfbaselines.backends.run_on_host()[source]

nerfbaselines.backends.protocol_shm_pickle

exception nerfbaselines.backends.protocol_shm_pickle.ConnectionClosed[source]

Bases: ConnectionError

class nerfbaselines.backends.protocol_shm_pickle.SharedMemoryProtocol(*, shared_memory_name=None, shared_memory_size=134217728)[source]

Bases: object

close()[source]
connect_worker()[source]
get_worker_configuration()[source]
property protocol_name
receive(interrupt=False)[source]
send(message, interrupt=False)[source]
start_host()[source]
wait_for_worker(timeout=None)[source]

nerfbaselines.backends.protocol_tcp_pickle

class nerfbaselines.backends.protocol_tcp_pickle.TCPPickleProtocol(*, hostname=None, port=None, authkey=None, max_message_size=134217728)[source]

Bases: object

close()[source]
connect_worker()[source]
get_worker_configuration()[source]
property protocol_name
receive(interrupt=False)[source]
send(message, interrupt=False)[source]
start_host()[source]
wait_for_worker(timeout=None)[source]