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

[air] Deprecate some fields/classes that are supposed to be gone in 2.6. #38794

Merged
merged 14 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix doc tests.
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
  • Loading branch information
xwjiang2010 committed Aug 24, 2023
commit b731242cd3b22a72872a7dfd6b9c1730b10e1d16
2 changes: 1 addition & 1 deletion doc/source/tune/doc_code/key_concepts.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def load_checkpoint(self, checkpoint_dir):

best_result = results.get_best_result() # Get best result object
best_config = best_result.config # Get best trial's hyperparameters
best_logdir = best_result.log_dir # Get best trial's logdir
best_logdir = best_result.path # Get best trial's result directory
best_checkpoint = best_result.checkpoint # Get best trial's best checkpoint
best_metrics = best_result.metrics # Get best trial's last results
best_result_df = best_result.metrics_dataframe # Get best result as pandas dataframe
Expand Down
4 changes: 2 additions & 2 deletions doc/source/tune/examples/pbt_guide.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,8 @@
"# Get the best trial result\n",
"best_result = results_grid.get_best_result(metric=\"mean_accuracy\", mode=\"max\")\n",
"\n",
"# Print `log_dir` where checkpoints are stored\n",
"print('Best result logdir:', best_result.log_dir)\n",
"# Print `path` where checkpoints are stored\n",
"print('Best result logdir:', best_result.path)\n",
"\n",
"# Print the best trial `config` reported at the last iteration\n",
"# NOTE: This config is just what the trial ended up with at the last iteration.\n",
Expand Down
4 changes: 2 additions & 2 deletions doc/source/tune/examples/tune_analyze_results.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@
"id": "403111f9",
"metadata": {},
"source": [
"Next, we can access the trial's log directory via `Result.log_dir`. The result `log_dir` gives the trial level directory that contains checkpoints (if you had checkpointing enabled) and logged metrics to load manually or inspect using a tool like Tensorboard (see `result.json`, `progress.csv`)."
"Next, we can access the trial's log directory via `Result.path`. The result `path` gives the trial level directory that contains checkpoints (if you had checkpointing enabled) and logged metrics to load manually or inspect using a tool like Tensorboard (see `result.json`, `progress.csv`)."
]
},
{
Expand All @@ -551,7 +551,7 @@
}
],
"source": [
"best_result.log_dir"
"best_result.path"
]
},
{
Expand Down