search

TUM-DAML / seml

SEML: Slurm Experiment Management Library
Other
165 stars 29 forks source link

Suggest to loosen the dependency on sacred #105

Closed Agnes-U closed 1 year ago

Agnes-U commented 1 year ago

Hi, your project seml requires "sacred>=0.8.1" in its dependency. After analyzing the source code, we found that some other versions of sacred can also be suitable without affecting your project, i.e., sacred 0.8.0. Therefore, we suggest to loosen the dependency on sacred from "sacred>=0.8.1" to "sacred>=0.8.0" to avoid any possible conflict for importing more packages or for downstream projects that may use seml.

May I pull a request to loosen the dependency on sacred?

By the way, could you please tell us whether such dependency analysis may be potentially helpful for maintaining dependencies easier during your development?


For your reference, here are details in our analysis.

Your project seml(commit id: 0e74689702f49ab59b3e1706ff66c768bef4ad7d) directly uses 14 APIs from package sacred.

sacred.initialize.create_run, sacred.observers.base.td_format, sacred.utils.join_paths, sacred.utils.iterate_flattened, sacred.utils.iter_prefixes, sacred.experiment.Experiment.__init__, sacred.observers.base.RunObserver.__init__, sacred.observers.mongo.MongoObserver.create, sacred.observers.slack.SlackObserver.__init__, sacred.config.config_files.load_config_file, sacred.ingredient.Ingredient.command, sacred.utils.ConfigAddedError.__init__, sacred.observers.file_storage.FileStorageObserver.__init__, sacred.ingredient.Ingredient.capture

From which, 71 functions are then indirectly called, including 47 sacred's internal APIs and 24 outsider APIs, as follows (neglecting some repeated function occurrences). 

[/TUM-DAML/seml]
+--sacred.initialize.create_run
|      +--sacred.initialize.gather_ingredients_topological
|      |      +--collections.defaultdict
|      +--sacred.initialize.create_scaffolding
|      |      +--collections.OrderedDict
|      |      +--sacred.initialize.Scaffold.__init__
|      |      |      +--sacred.utils.join_paths
|      |      +--collections.OrderedDict.values
|      +--sacred.utils.convert_to_nested_dict
|      |      +--sacred.utils.iterate_flattened
|      |      |      +--sacred.utils.iterate_flattened
|      |      |      |      +--sacred.utils.join_paths
|      |      +--sacred.utils.set_by_dotted_path
|      +--sacred.initialize.initialize_logging
|      |      +--sacred.utils.create_basic_stream_logger
|      |      |      +--logging.basicConfig
|      |      |      +--logging.getLogger
|      +--sacred.initialize.distribute_config_updates
|      |      +--sacred.utils.iterate_flattened
|      |      +--sacred.initialize.find_best_match
|      |      +--sacred.utils.set_by_dotted_path
|      +--sacred.initialize.get_scaffolding_and_config_name
|      |      +--os.path.exists
|      +--sacred.initialize.distribute_presets
|      |      +--sacred.utils.iterate_flattened
|      |      +--sacred.initialize.find_best_match
|      |      +--sacred.utils.set_by_dotted_path
|      +--sacred.utils.iterate_flattened
|      +--sacred.utils.set_by_dotted_path
|      +--sacred.utils.join_paths
|      +--sacred.initialize.get_configuration
|      |      +--sacred.utils.set_by_dotted_path
|      +--sacred.utils.recursive_update
|      |      +--sacred.utils.recursive_update
|      +--sacred.initialize.get_config_modifications
|      |      +--sacred.config.config_summary.ConfigSummary.__init__
|      |      |      +--sacred.config.config_summary.ConfigSummary.ensure_coherence
|      |      |      |      +--sacred.utils.iter_prefixes
|      |      |      |      |      +--sacred.utils.join_paths
|      |      +--sacred.config.config_summary.ConfigSummary.update_add
|      |      |      +--sacred.utils.join_paths
|      |      |      +--sacred.config.config_summary.ConfigSummary.ensure_coherence
|      +--sacred.host_info.get_host_info
|      +--sacred.initialize.get_command
|      +--sacred.run.Run.__init__
|      |      +--sacred.metrics_logger.MetricsLogger.__init__
|      |      |      +--queue.Queue
|      +--copy.copy
+--sacred.observers.base.td_format
+--sacred.utils.join_paths
+--sacred.utils.iterate_flattened
+--sacred.utils.iter_prefixes
+--sacred.experiment.Experiment.__init__
|      +--sacred.host_info.check_additional_host_info
|      +--sacred.experiment.gather_command_line_options
|      |      +--sacred.utils.get_inheritors
|      |      +--warnings.warn
|      +--inspect.stack
|      +--os.path.basename
|      +--sacred.ingredient.Ingredient.__init__
|      |      +--collections.OrderedDict
|      |      +--inspect.stack
|      |      +--os.path.dirname
|      |      +--os.path.abspath
|      |      +--sacred.dependencies.gather_sources_and_dependencies
|      |      |      +--sacred.dependencies.get_main_file
|      |      |      |      +--os.path.abspath
|      |      |      |      +--sacred.dependencies.Source.create
|      |      |      |      |      +--os.path.exists
|      |      |      |      |      +--sacred.dependencies.get_py_file_if_possible
|      |      |      |      |      |      +--os.path.exists
|      |      |      |      |      +--os.path.abspath
|      |      |      |      |      +--sacred.dependencies.get_commit_if_possible
|      |      |      |      |      |      +--os.path.dirname
|      |      |      |      |      |      +--git.Repo
|      |      |      |      |      |      +--git.Repo.remote
|      |      |      |      |      |      +--git.Repo.is_dirty
|      |      |      |      |      +--sacred.dependencies.Source.__init__
|      |      |      |      |      +--sacred.dependencies.get_digest
|      |      |      |      |      |      +--hashlib.md5
|      |      |      |      +--os.path.dirname
|      |      |      +--sacred.dependencies.PackageDependency.create
|      |      |      |      +--sacred.dependencies.PackageDependency.__init__
|      +--sacred.ingredient.Ingredient.command
|      |      +--sacred.ingredient.Ingredient.capture
|      |      |      +--sacred.config.captured_function.create_captured_function
|      |      |      |      +--sacred.config.signature.Signature.__init__
|      |      |      |      |      +--sacred.config.signature.get_argspec
|      |      |      |      |      |      +--inspect.signature
|      |      |      |      |      |      +--collections.OrderedDict
|      |      |      |      +--sacred.config.captured_function.captured_function
|      |      |      |      |      +--sacred.config.custom_containers.fallback_dict
|      |      |      |      |      +--sacred.randomness.get_seed
|      |      |      |      |      |      +--random.randint
|      |      |      |      |      +--sacred.randomness.create_rnd
|      |      |      |      |      |      +--random.Random
|      |      |      |      |      +--time.time
|      |      |      |      |      +--sacred.utils.ConfigError.track
|      |      |      |      |      |      +--sacred.utils.join_paths
|      |      |      |      |      +--datetime.timedelta
|      +--sacred.commands.print_named_configs
|      |      +--collections.OrderedDict
|      |      +--sacred.commands._format_named_configs
|      |      |      +--sacred.commands._format_named_config
+--sacred.observers.base.RunObserver.__init__
+--sacred.observers.mongo.MongoObserver.create
|      +--warnings.warn
+--sacred.observers.slack.SlackObserver.__init__
+--sacred.config.config_files.load_config_file
|      +--sacred.config.config_files.get_handler
|      |      +--os.path.splitext
+--sacred.ingredient.Ingredient.command
+--sacred.utils.ConfigAddedError.__init__
|      +--sacred.utils.ConfigError.__init__
|      |      +--sacred.utils.SacredError.__init__
+--sacred.observers.file_storage.FileStorageObserver.__init__
|      +--pathlib.Path
|      +--os.path.exists
|      +--sacred.observers.file_storage.FileStorageObserver.initialize
+--sacred.ingredient.Ingredient.capture

We scan sacred's versions among [0.8.0] and 0.8.1, the changing functions (diffs being listed below) have none intersection with any function or API we mentioned above (either directly or indirectly called by this project).

diff: 0.8.1(original) 0.8.0
['sacred.observers.mongo.MongoObserver.insert', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver._determine_run_dir', 'sacred.serializer.NumpyGenericHandler.flatten', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.log_metrics', 'sacred.serializer.NumpyArrayHandler.flatten', 'sacred.observers.mongo.QueuedMongoObserver', 'sacred.serializer.PandasDataframeHandler', 'sacred.observers.mongo.QueuedMongoObserver.__init__', 'sacred.observers.gcs_observer._is_valid_bucket', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.interrupted_event', 'sacred.observers.gcs_observer.gcs_option', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.heartbeat_event', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.failed_event', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.artifact_event', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.resource_event', 'sacred.serializer.NumpyArrayHandler.restore', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver', 'sacred.experiment.Experiment', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.find_or_save', 'sacred.observers.queue.QueueObserver', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_file_to_base', 'sacred.serializer.NumpyArrayHandler', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.started_event', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver._objects_exist_in_dir', 'sacred.observers.mongo.QueueCompatibleMongoObserver.save', 'sacred.serializer.PandasDataframeHandler.flatten', 'sacred.observers.mongo.QueueCompatibleMongoObserver', 'sacred.observers.mongo.MongoObserver', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver._list_gcs_subdirs', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.__eq__', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.completed_event', 'sacred.serializer.NumpyGenericHandler.restore', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_directory', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.put_data', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.queued_event', 'sacred.serializer.NumpyGenericHandler', 'sacred.observers.queue.QueueObserver.__init__', 'sacred.observers.queue.QueueObserver._run', 'sacred.experiment.Experiment._check_command', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_cout', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_file', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.__init__', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_sources', 'sacred.serializer.PandasDataframeHandler.restore', 'sacred.observers.gcs_observer.gcs_join', 'sacred.observers.gcs_observer.GoogleCloudStorageObserver.save_json', 'sacred.observers.mongo.MongoObserver._try_to_detect_content_type']

As for other packages, the APIs of @outside_package_name are called by sacred in the call graph and the dependencies on these packages also stay the same in our suggested versions, thus avoiding any outside conflict.

Therefore, we believe that it is quite safe to loose your dependency on sacred from "sacred>=0.8.1" to "sacred>=0.8.0". This will improve the applicability of seml and reduce the possibility of any further dependency conflict with other projects/packages.

Agnes-U commented 1 year ago

I found that the modification has been done before, here, thanks~