deepSSF 0.1.1__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.
deepssf/__init__.py ADDED
@@ -0,0 +1,82 @@
1
+ """deepssf — deep learning step selection functions for animal movement.
2
+
3
+ This top-level module defines the *public API*: the names users get when they
4
+ do ``import deepssf`` or ``from deepssf import ...``. Keep it curated — only
5
+ expose the things you want people to rely on. Internal helpers stay private.
6
+ """
7
+
8
+ # Single source of truth for the version. hatchling reads this string at build
9
+ # time (see pyproject.toml [tool.hatch.version]). Bump it when you release.
10
+ __version__ = "0.1.1"
11
+
12
+ from deepssf.data import (
13
+ MovementDataset,
14
+ filter_steps_by_window,
15
+ load_environmental_layers,
16
+ load_s2_data,
17
+ make_dataloaders,
18
+ prepare_movement_df,
19
+ )
20
+ from deepssf.model import ConvJointModel, ModelParams
21
+ from deepssf.simulate import (
22
+ make_simulation_inputs,
23
+ simulate_next_step,
24
+ simulate_trajectory,
25
+ )
26
+ from deepssf.train import (
27
+ EarlyStopping,
28
+ fit,
29
+ make_optimisers,
30
+ negativeLogLikeLoss,
31
+ test_loop,
32
+ train_loop,
33
+ )
34
+ from deepssf.utils import (
35
+ clear_memory,
36
+ create_gif,
37
+ get_device,
38
+ recover_hour,
39
+ recover_yday,
40
+ subset_layer_vectorized,
41
+ subset_raster_all_bands_torch,
42
+ subset_raster_with_padding_npy,
43
+ subset_raster_with_padding_torch,
44
+ )
45
+ from deepssf.validate import validate_next_step_probs
46
+
47
+ __all__ = [
48
+ "__version__",
49
+ # model
50
+ "ConvJointModel",
51
+ "ModelParams",
52
+ # train
53
+ "negativeLogLikeLoss",
54
+ "EarlyStopping",
55
+ "train_loop",
56
+ "test_loop",
57
+ "make_optimisers",
58
+ "fit",
59
+ # data
60
+ "MovementDataset",
61
+ "filter_steps_by_window",
62
+ "load_environmental_layers",
63
+ "load_s2_data",
64
+ "make_dataloaders",
65
+ "prepare_movement_df",
66
+ # simulate
67
+ "make_simulation_inputs",
68
+ "simulate_next_step",
69
+ "simulate_trajectory",
70
+ # validate
71
+ "validate_next_step_probs",
72
+ # utils
73
+ "get_device",
74
+ "clear_memory",
75
+ "create_gif",
76
+ "recover_hour",
77
+ "recover_yday",
78
+ "subset_layer_vectorized",
79
+ "subset_raster_with_padding_torch",
80
+ "subset_raster_all_bands_torch",
81
+ "subset_raster_with_padding_npy",
82
+ ]