Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggest to loosen the dependency on sacred #2

Open
Agnes-U opened this issue Jul 25, 2022 · 0 comments
Open

Suggest to loosen the dependency on sacred #2

Agnes-U opened this issue Jul 25, 2022 · 0 comments

Comments

@Agnes-U
Copy link

Agnes-U commented Jul 25, 2022

Hi, your project neuralRDEs requires "sacred==0.8.1" in its dependency. After analyzing the source code, we found that the following 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,<=0.8.1" to avoid any possible conflict for importing more packages or for downstream projects that may use neuralRDEs.

May I pull a request to further 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?



We also give our detailed analysis as follows for your reference:

Your project neuralRDEs directly uses 3 APIs from package sacred.

sacred.experiment.Experiment.__init__, sacred.ingredient.Ingredient.__init__, sacred.observers.file_storage.FileStorageObserver.__init__

Beginning from the 3 APIs above, 44 functions are then indirectly called, including 27 sacred's internal APIs and 17 outsider APIs. The specific call graph is listed as follows (neglecting some repeated function occurrences).

[/jambo6/neuralRDEs]
+--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.ingredient.Ingredient.__init__
+--sacred.observers.file_storage.FileStorageObserver.__init__
|      +--pathlib.Path
|      +--os.path.exists
|      +--sacred.observers.file_storage.FileStorageObserver.initialize

We scan sacred's versions and observe that during its evolution between any version from [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 inspect, os, collections, pathlib, warnings, time, datetime, git, hashlib and random 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,<=0.8.1". This will improve the applicability of neuralRDEs and reduce the possibility of any further dependency conflict with other projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant