docstring for make_dataset is incomplete

[musoke]

deeplenstronomy/deeplenstronomy/deeplenstronomy.py

Lines 267 to 293 in 00abf49

	def make_dataset(config, dataset=None, save_to_disk=False, store_in_memory=True,
	verbose=False, store_sample=False, image_file_format='npy',
	survey=None, return_planes=False, skip_image_generation=False,
	solve_lens_equation=False):
	"""
	Generate a dataset from a config file.
	Args:
	config (str or dict): name of yaml file specifying dataset characteristics or pre-parsed yaml file as dictionary
	verbose (bool, optional, default=False): print progress and status updates at runtime
	store_in_memory (bool, optional, default=True): save images and metadata as attributes
	save_to_disk (bool, optional, default=False): save images and metadata to disk
	store_sample (bool, optional, default=False): save five images and metadata as attribute
	image_file_format (str, optional, default='npy'): outfile format type, options include ('npy', 'h5')
	survey (str or None, optional, default=None): a default astronomical survey to use
	return_planes (bool, optional, default=False): return the lens, source, noise, and point source planes of the simulated images
	skip_image_generation (bool, optional, default=False): skip image generation
	solve_lens_equation (bool, optional, default=False): calculate the source positions
	Returns:
	dataset (Dataset): and instance of the Dataset class
	Raises:
	RuntimeError: If `skip_image_generation == True` and `solve_lens_equation == True`
	RuntimeError: If `survey` is not a valid survey name
	"""

does not indicate the significance of param dataset or its expected type.