conda_dependencies contructor description is faulty

[omartin2010]

conda_dependencies
CondaDependencies
When left at the default value of False, the system creates a Python environment, which includes the packages specified in conda_dependencies. When set true, an existing Python environment can be specified with the python_interpreter setting.

This doesn't make sense... it's suppsoed to be a CondaDependencies object, not a bool as the description implies.

[Enter feedback here]

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 882f737f-4f00-3cc2-d9b8-410c09fdad9f
• Version Independent ID: ea049c24-1544-523b-c9ba-e3b805d60492
• Content: azureml.core.RunConfiguration class - Azure Machine Learning Python
• Content Source: AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.RunConfiguration.yml
• Service: machine-learning
• Sub-service: core
• GitHub Login: @DebFro
• Microsoft Alias: debfro

[vizhur]

@omartin2010 Hi Olivier, I'm confused,
constructor takes only one non-private parameter that is the path to conda environment yml file
CondaDependencies(conda_dependencies_file_path=None, _underlying_structure=None)

if you talking about RunConfiguration class, it takes only one boolean (auto_prepare_environment) that is deprecated

[dataders]

@vizhur look at the param description for RunConfiguration's conda_dependencies:

When left at the default value of False, the system creates a Python environment, which includes the packages specified in conda_dependencies. When set true, an existing Python environment can be specified with the python_interpreter setting.

I think @omartin2010 's point is:

1. the description should probably talk about how the param is most often used which is to pass a CondaDependencies object
2. default value of False directly contradicts the function signature provided at the top of the page which gives the default argument of None

[omartin2010]

you nailed it, @swanderz . I would not imagine conda_dependencies to be a bool, but either a CondaDependencies object, or not exist at all and that in the docs of RunConfiguration we can (easily) know that CondaDependencies are set as part of the Environment (which is confusing because it's not part of the constructor which it could also be in my view).