myria3d
Getting Started
Install Myria3D on Linux
Setting up a virtual environment
Install source as a package
Troubleshooting
Install Myria3D on WSL2 with CUDA support
Setting up WSL2
Installing Anaconda
Installing Myria3D
Install cuda in WSL
Troubleshooting
Preparing data for training
Peprocessing functions
Preparing the dataset
Getting started quickly with a toy dataset
Performing inference on new data
Run inference from source
Run inference from sources
Run inference from within a docker image
Additional options for prediction
Guides
How to train new models
Setup
Quick run
Training
Testing the model
Inference
Developer’s guide
Code versionning
Tests
Continuous Integration (CI)
Continuous Delivery (CD)
Background
KNN-Interpolation to merge multiple predictions [TODO]
General design of the package
Model should be fast, performant, and practical
Subsampling is important to improve point cloud structure
Speed is of the essence
Evaluation is key to select the right approach
Package Reference
Scripts
run
myria3d.train
myria3d.predict
Default configuration
myria3d.pctl
myria3d.pctl.datamodule.hdf5
myria3d.pctl.dataset.hdf5
myria3d.pctl.dataset.iterable
myria3d.pctl.dataset.toy_dataset
myria3d.pctl.dataset.utils
myria3d.pctl.dataloader.dataloader
myria3d.pctl.points_pre_transform.lidar_hd
myria3d.pctl.transforms.compose
myria3d.pctl.transforms.transforms
myria3d.models
Model
Interpolation
myria3d.models.modules
(Pytorch-Geometric) RandLA-Net
myria3d.callbacks
Submodules
myria3d.callbacks.comet_callbacks
myria3d.callbacks.finetuning_callbacks
myria3d.callbacks.logging_callbacks
Module contents
myria3d.utils
myria3d.utils.utils
myria3d
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
Symbols
**kwargs (myria3d.callbacks.comet_callbacks.CometLogger parameter)
(myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
`split` (myria3d.pctl.dataset.toy_dataset.make_toy_dataset_from_test_file parameter)
A
api_key (myria3d.callbacks.comet_callbacks.CometLogger parameter)
ascii (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
asrecarray (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
B
balanced_tree (myria3d.pctl.dataset.utils.cKDTree parameter)
bar_format (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
base (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
basename (myria3d.models.interpolation.Interpolator.reduce_predictions_and_save parameter)
batch (myria3d.models.model.Model.forward parameter)
(myria3d.models.model.Model.predict_step parameter)
(myria3d.models.model.Model.test_step parameter)
(myria3d.models.model.Model.training_step parameter)
(myria3d.models.model.Model.validation_step parameter)
batch_idx (myria3d.models.model.Model.training_step parameter)
(myria3d.models.model.Model.validation_step parameter)
batch_sampler (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
batch_size (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
batch_x (myria3d.models.model.knn_interpolate parameter)
batch_y (myria3d.models.model.knn_interpolate parameter)
boxsize (myria3d.pctl.dataset.utils.cKDTree parameter)
C
class_name (myria3d.models.model.get_neural_net_class parameter)
collate_fn (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
colour (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
compact_nodes (myria3d.pctl.dataset.utils.cKDTree parameter)
config (myria3d.train.train parameter)
(myria3d.utils.utils.extras parameter)
(myria3d.utils.utils.print_config parameter)
configure_optimizers() (myria3d.models.model.Model method)
copy_data (myria3d.pctl.dataset.utils.cKDTree parameter)
CopyFullPos (class in myria3d.pctl.transforms.transforms)
CopyFullPreparedTargets (class in myria3d.pctl.transforms.transforms)
CopySampledPos (class in myria3d.pctl.transforms.transforms)
create_hdf5() (in module myria3d.pctl.dataset.hdf5)
CustomCompose (class in myria3d.pctl.transforms.compose)
D
data (myria3d.pctl.dataset.utils.cKDTree parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
dataset (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
(myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule property)
define_device_from_config_param() (in module myria3d.utils.utils)
delay (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
desc (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
disable (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
drop_last (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
DropPointsByClass (class in myria3d.pctl.transforms.transforms)
dtypes (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
dynamic_ncols (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
E
edge_attr (myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
edge_index (myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
epsg (myria3d.models.interpolation.get_pdal_reader parameter)
(myria3d.models.interpolation.Interpolator.load_full_las_for_update parameter)
(myria3d.models.interpolation.Interpolator.reduce_predictions_and_save parameter)
(myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(myria3d.pctl.dataset.hdf5.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.iterable.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.utils.get_pdal_reader parameter)
(myria3d.pctl.dataset.utils.pdal_read_las_array parameter)
(myria3d.pctl.dataset.utils.split_cloud_into_samples parameter)
(run.create_hdf5 parameter)
eval_time() (in module myria3d.utils.utils)
experiment_key (myria3d.callbacks.comet_callbacks.CometLogger parameter)
extras() (in module myria3d.utils.utils)
F
fields (myria3d.utils.utils.print_config parameter)
file (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
filepath (myria3d.models.interpolation.Interpolator.load_full_las_for_update parameter)
files (myria3d.pctl.dataset.toy_dataset.make_toy_dataset_from_test_file parameter)
fill_value (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
find_file_in_dir() (in module myria3d.pctl.dataset.utils)
FINETUNE (run.TASK_NAMES attribute)
finetune_function() (myria3d.callbacks.finetuning_callbacks.FinetuningFreezeUnfreeze method)
FinetuningFreezeUnfreeze (class in myria3d.callbacks.finetuning_callbacks)
FIT (run.TASK_NAMES attribute)
forward() (myria3d.models.model.Model method)
(myria3d.models.modules.pyg_randla_net.PyGRandLANet method)
freeze_before_training() (myria3d.callbacks.finetuning_callbacks.FinetuningFreezeUnfreeze method)
G
generator (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
GeometricNoneProofCollater (class in myria3d.pctl.dataloader.dataloader)
GeometricNoneProofDataloader (class in myria3d.pctl.dataloader.dataloader)
get_comet_logger() (in module myria3d.callbacks.comet_callbacks)
get_iterator() (myria3d.pctl.dataset.iterable.InferenceDataset method)
get_logger() (in module myria3d.utils.utils)
get_metadata() (in module myria3d.pctl.dataset.utils)
get_neural_net_class() (in module myria3d.models.model)
get_pdal_info_metadata() (in module myria3d.pctl.dataset.utils)
get_pdal_reader() (in module myria3d.pctl.dataset.utils)
gui (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
H
HDF5 (run.TASK_NAMES attribute)
hdf5_file_path (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(run.create_hdf5 parameter)
HDF5Dataset (class in myria3d.pctl.dataset.hdf5)
HDF5LidarDataModule (class in myria3d.pctl.datamodule.hdf5)
I
InferenceDataset (class in myria3d.pctl.dataset.iterable)
initial (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
input_data_dir (myria3d.pctl.dataset.utils.find_file_in_dir parameter)
interpolation (myria3d.models.interpolation.Interpolator.reduce_predictions_and_save parameter)
Interpolator (class in myria3d.models.interpolation)
iterable (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
K
k (myria3d.models.model.knn_interpolate parameter)
L
las_path (myria3d.models.interpolation.get_pdal_info_metadata parameter)
(myria3d.models.interpolation.get_pdal_reader parameter)
(myria3d.pctl.dataset.hdf5.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.iterable.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.utils.get_metadata parameter)
(myria3d.pctl.dataset.utils.get_pdal_info_metadata parameter)
(myria3d.pctl.dataset.utils.get_pdal_reader parameter)
(myria3d.pctl.dataset.utils.pdal_read_las_array parameter)
(myria3d.pctl.dataset.utils.split_cloud_into_samples parameter)
las_paths_by_split_dict (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(run.create_hdf5 parameter)
launch_hdf5() (in module run)
launch_predict() (in module run)
launch_train() (in module run)
leafsize (myria3d.pctl.dataset.utils.cKDTree parameter)
leave (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
lidar_hd_pre_transform() (in module myria3d.pctl.points_pre_transform.lidar_hd)
load_full_las_for_update() (myria3d.models.interpolation.Interpolator method)
lock_args (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
log_comet_cm() (in module myria3d.callbacks.comet_callbacks)
log_hyperparameters() (in module myria3d.utils.utils)
LogCode (class in myria3d.callbacks.comet_callbacks)
logits (myria3d.models.interpolation.Categorical parameter)
LogLogsPath (class in myria3d.callbacks.comet_callbacks)
M
make_toy_dataset_from_test_file() (in module myria3d.pctl.dataset.toy_dataset)
MaximumNumNodes (class in myria3d.pctl.transforms.transforms)
maxinterval (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
MinimumNumNodes (class in myria3d.pctl.transforms.transforms)
mininterval (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
miniters (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
mode (myria3d.callbacks.comet_callbacks.CometLogger parameter)
Model (class in myria3d.models.model)
module
myria3d.callbacks
myria3d.callbacks.comet_callbacks
myria3d.callbacks.finetuning_callbacks
myria3d.models.interpolation
myria3d.models.model
myria3d.pctl.dataloader.dataloader
myria3d.pctl.datamodule.hdf5
myria3d.pctl.dataset.hdf5
myria3d.pctl.dataset.iterable
myria3d.pctl.dataset.toy_dataset
myria3d.pctl.dataset.utils
myria3d.pctl.points_pre_transform.lidar_hd
myria3d.pctl.transforms.compose
myria3d.pctl.transforms.transforms
myria3d.predict
myria3d.train
myria3d.utils.utils
run
multiprocessing_context (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
myria3d.callbacks
module
myria3d.callbacks.comet_callbacks
module
myria3d.callbacks.finetuning_callbacks
module
myria3d.models.interpolation
module
myria3d.models.model
module
myria3d.pctl.dataloader.dataloader
module
myria3d.pctl.datamodule.hdf5
module
myria3d.pctl.dataset.hdf5
module
myria3d.pctl.dataset.iterable
module
myria3d.pctl.dataset.toy_dataset
module
myria3d.pctl.dataset.utils
module
myria3d.pctl.points_pre_transform.lidar_hd
module
myria3d.pctl.transforms.compose
module
myria3d.pctl.transforms.transforms
module
myria3d.predict
module
myria3d.train
module
myria3d.utils.utils
module
N
names (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
ncols (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
NormalizePos (class in myria3d.pctl.transforms.transforms)
nrows (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
NullifyLowestZ (class in myria3d.pctl.transforms.transforms)
num_workers (myria3d.models.model.knn_interpolate parameter)
(myria3d.pctl.dataloader.dataloader.DataLoader parameter)
O
on_train_start() (myria3d.callbacks.comet_callbacks.LogCode method)
online (myria3d.callbacks.comet_callbacks.CometLogger parameter)
output_dir (myria3d.models.interpolation.Interpolator.reduce_predictions_and_save parameter)
P
pdal_read_las_array() (in module myria3d.pctl.dataset.utils)
pdal_read_las_array_as_float32() (in module myria3d.pctl.dataset.utils)
persistent_workers (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
pin_memory (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
pin_memory_device (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
points (myria3d.pctl.dataset.hdf5.lidar_hd_pre_transform parameter)
(myria3d.pctl.dataset.iterable.lidar_hd_pre_transform parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.lidar_hd_pre_transform parameter)
points_pre_transform (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(run.create_hdf5 parameter)
pos (myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
pos_x (myria3d.models.model.knn_interpolate parameter)
pos_y (myria3d.models.model.knn_interpolate parameter)
position (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
postfix (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
pre_filter (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(run.create_hdf5 parameter)
PREDICT (run.TASK_NAMES attribute)
predict_dataloader() (myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
predict_step() (myria3d.models.model.Model method)
prefetch_factor (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
prefix (myria3d.callbacks.comet_callbacks.CometLogger parameter)
prepare_data() (myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
prepared_data_dir (myria3d.pctl.dataset.toy_dataset.make_toy_dataset_from_test_file parameter)
print_config() (in module myria3d.utils.utils)
printed and in what order. (myria3d.utils.utils.print_config parameter)
probabilities. Defaults to None. (myria3d.models.interpolation.Interpolator.reduce_predictions_and_save parameter)
probs (myria3d.models.interpolation.Categorical parameter)
project (myria3d.callbacks.comet_callbacks.CometLogger parameter)
PyGRandLANet (class in myria3d.models.modules.pyg_randla_net)
R
reduce_predicted_logits() (myria3d.models.interpolation.Interpolator method)
reduce_predictions_and_save() (myria3d.models.interpolation.Interpolator method)
resolve (myria3d.utils.utils.print_config parameter)
run
module
S
sampler (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
samples_hdf5_paths (myria3d.pctl.dataset.hdf5.HDF5Dataset property)
seed (myria3d.train.seed_everything parameter)
setup() (myria3d.callbacks.comet_callbacks.LogLogsPath method)
(myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
shuffle (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
smoothing (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
split_cloud_into_samples() (in module myria3d.pctl.dataset.utils)
split_csv (myria3d.pctl.dataset.toy_dataset.make_toy_dataset_from_test_file parameter)
src_las_path (myria3d.pctl.dataset.toy_dataset.make_toy_dataset_from_test_file parameter)
standardize_channel() (myria3d.pctl.transforms.transforms.StandardizeRGBAndIntensity method)
StandardizeRGBAndIntensity (class in myria3d.pctl.transforms.transforms)
store_predictions() (myria3d.models.interpolation.Interpolator method)
subtile_overlap (myria3d.pctl.dataset.hdf5.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.iterable.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.utils.split_cloud_into_samples parameter)
subtile_overlap_train (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(run.create_hdf5 parameter)
subtile_width (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(myria3d.pctl.dataset.hdf5.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.iterable.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.utils.split_cloud_into_samples parameter)
(run.create_hdf5 parameter)
T
TargetTransform (class in myria3d.pctl.transforms.transforms)
TASK_NAMES (class in run)
TEST (run.TASK_NAMES attribute)
test_dataloader() (myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
test_step() (myria3d.models.model.Model method)
tile_width (myria3d.pctl.dataset.hdf5.create_hdf5 parameter)
(myria3d.pctl.dataset.hdf5.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.iterable.split_cloud_into_samples parameter)
(myria3d.pctl.dataset.utils.split_cloud_into_samples parameter)
(run.create_hdf5 parameter)
time (myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
timeout (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
total (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
ToTensor (class in myria3d.pctl.transforms.transforms)
train() (in module myria3d.train)
train_dataloader() (myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
training_step() (myria3d.models.model.Model method)
transforms (myria3d.pctl.datamodule.hdf5.CustomCompose parameter)
(myria3d.pctl.transforms.compose.CustomCompose parameter)
U
unit (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
unit_divisor (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
unit_scale (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
usemask (myria3d.pctl.points_pre_transform.lidar_hd.append_fields parameter)
V
val_dataloader() (myria3d.pctl.datamodule.hdf5.HDF5LidarDataModule method)
validation_step() (myria3d.models.model.Model method)
verbose (myria3d.train.seed_everything parameter)
W
worker_init_fn (myria3d.pctl.dataloader.dataloader.DataLoader parameter)
workers (myria3d.train.seed_everything parameter)
workspace (myria3d.callbacks.comet_callbacks.CometLogger parameter)
write_bytes (myria3d.pctl.dataset.hdf5.tqdm parameter)
(myria3d.predict.tqdm parameter)
(run.tqdm parameter)
X
x (myria3d.models.model.knn_interpolate parameter)
(myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)
Y
y (myria3d.models.model.Model.forward parameter)
(myria3d.models.model.Model.predict_step parameter)
(myria3d.models.model.Model.test_step parameter)
(myria3d.models.model.Model.training_step parameter)
(myria3d.models.model.Model.validation_step parameter)
(myria3d.pctl.datamodule.hdf5.Data parameter)
(myria3d.pctl.dataset.hdf5.Data parameter)
(myria3d.pctl.dataset.iterable.Data parameter)
(myria3d.pctl.points_pre_transform.lidar_hd.Data parameter)
(myria3d.pctl.transforms.transforms.Data parameter)