File size: 3,732 Bytes
fc0f7bd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | // Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
function FBInternalOnly(elements) {
return process.env.FB_INTERNAL ? elements : [];
}
module.exports = {
Docs: {
About: [
'intro',
'terminology',
],
Tutorials: [
'tutorials/intro',
{
type: 'category',
label: 'Basic Tutorial',
items: [
{
type: 'category',
label: 'Your first Hydra app',
items: [
'tutorials/basic/your_first_app/simple_cli',
'tutorials/basic/your_first_app/config_file',
'tutorials/basic/your_first_app/using_config',
'tutorials/basic/your_first_app/config_groups',
'tutorials/basic/your_first_app/defaults',
'tutorials/basic/your_first_app/composition',
]
},
{
type: 'category',
label: 'Running your Hydra app',
items: [
'tutorials/basic/running_your_app/multi-run',
'tutorials/basic/running_your_app/working_directory',
'tutorials/basic/running_your_app/logging',
'tutorials/basic/running_your_app/debugging',
'tutorials/basic/running_your_app/tab_completion',
]
},
],
},
{
type: 'category',
label: 'Structured Configs Tutorial',
items: [
'tutorials/structured_config/intro',
'tutorials/structured_config/minimal_example',
'tutorials/structured_config/nesting',
'tutorials/structured_config/config_groups',
'tutorials/structured_config/defaults',
'tutorials/structured_config/schema',
'tutorials/structured_config/config_store',
],
},
],
'Common Patterns': [
'patterns/objects',
'patterns/specializing_config',
],
'Configuring Hydra': [
'configure_hydra/intro',
'configure_hydra/job',
'configure_hydra/logging',
'configure_hydra/workdir',
'configure_hydra/app_help',
],
'Plugins': [
'plugins/ax_sweeper',
'plugins/colorlog',
'plugins/joblib_launcher',
'plugins/nevergrad_sweeper',
'plugins/submitit_launcher',
],
'Advanced': [
'advanced/overriding_packages',
'advanced/command_line_overrides',
'advanced/search_path',
'advanced/plugins',
'advanced/app_packaging',
],
"Experimental": [
"experimental/intro",
'experimental/compose_api',
'experimental/ray_example',
],
'Development': [
'development/contributing',
'development/release',
],
Upgrades: [
{
type: 'category',
label: '0.11 to 1.0',
items: [
'upgrades/0.11_to_1.0/config_path_changes',
'upgrades/0.11_to_1.0/adding_a_package_directive',
'upgrades/0.11_to_1.0/strict_mode_flag_deprecated',
],
},
],
'FB Only': FBInternalOnly([
'fb/intro',
'fb/fbcode',
'fb/internal-fb-cluster',
'fb/fair-cluster',
]),
}
}
|