File size: 92,013 Bytes
9c6594c |
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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 |
import asyncio
import configparser
import datetime
import getpass
import json
import logging
import os
import shlex
import shutil
import subprocess
import sys
import tempfile
import textwrap
import time
import traceback
from functools import wraps
from typing import Any, Dict, Optional
import click
import yaml
from click.exceptions import ClickException
import wandb
import wandb.env
import wandb.errors
import wandb.sdk.verify.verify as wandb_verify
from wandb import Config, Error, env, util, wandb_agent, wandb_sdk
from wandb.apis import InternalApi, PublicApi
from wandb.apis.public import RunQueue
from wandb.errors.links import url_registry
from wandb.sdk import wandb_setup
from wandb.sdk.artifacts._validators import is_artifact_registry_project
from wandb.sdk.artifacts.artifact_file_cache import get_artifact_file_cache
from wandb.sdk.internal.internal_api import Api as SDKInternalApi
from wandb.sdk.launch import utils as launch_utils
from wandb.sdk.launch._launch_add import _launch_add
from wandb.sdk.launch.errors import ExecutionError, LaunchError
from wandb.sdk.launch.sweeps import utils as sweep_utils
from wandb.sdk.launch.sweeps.scheduler import Scheduler
from wandb.sdk.lib import filesystem
from wandb.sync import SyncManager, get_run_from_path, get_runs
from .beta import beta
# Send cli logs to wandb/debug-cli.<username>.log by default and fallback to a temp dir.
_wandb_dir = wandb.old.core.wandb_dir(env.get_dir())
if not os.path.exists(_wandb_dir):
_wandb_dir = tempfile.gettempdir()
try:
_username = getpass.getuser()
except KeyError:
# getuser() could raise KeyError in restricted environments like
# chroot jails or docker containers. Return user id in these cases.
_username = str(os.getuid())
_wandb_log_path = os.path.join(_wandb_dir, f"debug-cli.{_username}.log")
logging.basicConfig(
filename=_wandb_log_path,
level=logging.INFO,
format="%(asctime)s %(levelname)s %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
)
logging.basicConfig(stream=sys.stdout, level=logging.INFO)
logger = logging.getLogger("wandb")
_HAS_DOCKER = bool(shutil.which("docker"))
_HAS_NVIDIA_DOCKER = bool(shutil.which("nvidia-docker"))
# Click Contexts
CONTEXT = {"default_map": {}}
RUN_CONTEXT = {
"default_map": {},
"allow_extra_args": True,
"ignore_unknown_options": True,
}
def cli_unsupported(argument):
wandb.termerror(f"Unsupported argument `{argument}`")
sys.exit(1)
class ClickWandbException(ClickException):
def format_message(self):
orig_type = f"{self.orig_type.__module__}.{self.orig_type.__name__}"
if issubclass(self.orig_type, Error):
return click.style(str(self.message), fg="red")
else:
return (
f"An Exception was raised, see {_wandb_log_path} for full"
" traceback.\n"
f"{orig_type}: {self.message}"
)
def display_error(func):
"""Function decorator for catching common errors and re-raising as wandb.Error."""
@wraps(func)
def wrapper(*args, **kwargs):
try:
return func(*args, **kwargs)
except wandb.Error as e:
exc_type, exc_value, exc_traceback = sys.exc_info()
lines = traceback.format_exception(exc_type, exc_value, exc_traceback)
logger.exception("".join(lines))
wandb.termerror(f"Find detailed error logs at: {_wandb_log_path}")
click_exc = ClickWandbException(e)
click_exc.orig_type = exc_type
raise click_exc.with_traceback(sys.exc_info()[2])
return wrapper
_api = None # caching api instance allows patching from unit tests
def _get_cling_api(reset=None):
"""Get a reference to the internal api with cling settings."""
global _api
if reset:
_api = None
wandb.teardown()
if _api is None:
# TODO(jhr): make a settings object that is better for non runs.
# only override the necessary setting
wandb_setup.singleton().settings.x_cli_only_mode = True
_api = InternalApi()
return _api
def prompt_for_project(ctx, entity):
"""Ask the user for a project, creating one if necessary."""
result = ctx.invoke(projects, entity=entity, display=False)
api = _get_cling_api()
try:
if len(result) == 0:
project = click.prompt("Enter a name for your first project")
# description = editor()
project = api.upsert_project(project, entity=entity)["name"]
else:
project_names = [project["name"] for project in result] + ["Create New"]
wandb.termlog("Which project should we use?")
result = util.prompt_choices(project_names)
if result:
project = result
else:
project = "Create New"
# TODO: check with the server if the project exists
if project == "Create New":
project = click.prompt(
"Enter a name for your new project", value_proc=api.format_project
)
# description = editor()
project = api.upsert_project(project, entity=entity)["name"]
except wandb.errors.CommError as e:
raise ClickException(str(e))
return project
class RunGroup(click.Group):
@display_error
def get_command(self, ctx, cmd_name):
# TODO: check if cmd_name is a file in the current dir and not require `run`?
rv = click.Group.get_command(self, ctx, cmd_name)
if rv is not None:
return rv
return None
@click.command(cls=RunGroup, invoke_without_command=True)
@click.version_option(version=wandb.__version__)
@click.pass_context
def cli(ctx):
if ctx.invoked_subcommand is None:
click.echo(ctx.get_help())
@cli.command(context_settings=CONTEXT, help="List projects", hidden=True)
@click.option(
"--entity",
"-e",
default=None,
envvar=env.ENTITY,
help="The entity to scope the listing to.",
)
@display_error
def projects(entity, display=True):
api = _get_cling_api()
projects = api.list_projects(entity=entity)
if len(projects) == 0:
message = f"No projects found for {entity}"
else:
message = f'Latest projects for "{entity}"'
if display:
click.echo(click.style(message, bold=True))
for project in projects:
click.echo(
"".join(
(
click.style(project["name"], fg="blue", bold=True),
" - ",
str(project["description"] or "").split("\n")[0],
)
)
)
return projects
@cli.command(context_settings=CONTEXT, help="Login to Weights & Biases")
@click.argument("key", nargs=-1)
@click.option("--cloud", is_flag=True, help="Login to the cloud instead of local")
@click.option(
"--host", "--base-url", default=None, help="Login to a specific instance of W&B"
)
@click.option(
"--relogin", default=None, is_flag=True, help="Force relogin if already logged in."
)
@click.option("--anonymously", default=False, is_flag=True, help="Log in anonymously")
@click.option(
"--verify/--no-verify",
default=False,
is_flag=True,
help="Verify login credentials",
)
@display_error
def login(key, host, cloud, relogin, anonymously, verify, no_offline=False):
# TODO: handle no_offline
anon_mode = "must" if anonymously else "never"
wandb_sdk.wandb_login._handle_host_wandb_setting(host, cloud)
# A change in click or the test harness means key can be none...
key = key[0] if key is not None and len(key) > 0 else None
relogin = True if key or relogin else False
global_settings = wandb_setup.singleton().settings
global_settings.x_cli_only_mode = True
global_settings.x_disable_viewer = relogin and not verify
wandb.login(
anonymous=anon_mode,
force=True,
host=host,
key=key,
relogin=relogin,
verify=verify,
referrer="models",
)
@cli.command(
context_settings=CONTEXT, help="Run a wandb service", name="service", hidden=True
)
@click.option(
"--sock-port", default=None, type=int, help="The host port to bind socket service."
)
@click.option("--port-filename", default=None, help="Save allocated port to file.")
@click.option("--address", default=None, help="The address to bind service.")
@click.option("--pid", default=None, type=int, help="The parent process id to monitor.")
@click.option("--debug", is_flag=True, help="log debug info")
@display_error
def service(
sock_port=None,
port_filename=None,
address=None,
pid=None,
debug=False,
):
from wandb.sdk.service.server import WandbServer
server = WandbServer(
sock_port=sock_port,
port_fname=port_filename,
address=address,
pid=pid,
debug=debug,
)
server.serve()
@cli.command(
context_settings=CONTEXT, help="Configure a directory with Weights & Biases"
)
@click.option("--project", "-p", help="The project to use.")
@click.option("--entity", "-e", help="The entity to scope the project to.")
# TODO(jhr): Enable these with settings rework
# @click.option("--setting", "-s", help="enable an arbitrary setting.", multiple=True)
# @click.option('--show', is_flag=True, help="Show settings")
@click.option("--reset", is_flag=True, help="Reset settings")
@click.option(
"--mode",
"-m",
help=' Can be "online", "offline" or "disabled". Defaults to online.',
)
@click.pass_context
@display_error
def init(ctx, project, entity, reset, mode):
from wandb.old.core import __stage_dir__, _set_stage_dir, wandb_dir
if __stage_dir__ is None:
_set_stage_dir("wandb")
# non-interactive init
if reset or project or entity or mode:
api = InternalApi()
if reset:
api.clear_setting("entity", persist=True)
api.clear_setting("project", persist=True)
api.clear_setting("mode", persist=True)
# TODO(jhr): clear more settings?
if entity:
api.set_setting("entity", entity, persist=True)
if project:
api.set_setting("project", project, persist=True)
if mode:
api.set_setting("mode", mode, persist=True)
return
if os.path.isdir(wandb_dir()) and os.path.exists(
os.path.join(wandb_dir(), "settings")
):
click.confirm(
click.style(
"This directory has been configured previously, should we re-configure it?",
bold=True,
),
abort=True,
)
else:
click.echo(
click.style("Let's setup this directory for W&B!", fg="green", bold=True)
)
api = _get_cling_api()
if api.api_key is None:
ctx.invoke(login)
api = _get_cling_api(reset=True)
viewer = api.viewer()
# Viewer can be `None` in case your API information became invalid, or
# in testing if you switch hosts.
if not viewer:
click.echo(
click.style(
"Your login information seems to be invalid: can you log in again please?",
fg="red",
bold=True,
)
)
ctx.invoke(login)
api = _get_cling_api(reset=True)
# This shouldn't happen.
viewer = api.viewer()
if not viewer:
click.echo(
click.style(
"We're sorry, there was a problem logging you in. "
"Please send us a note at support@wandb.com and tell us how this happened.",
fg="red",
bold=True,
)
)
sys.exit(1)
# At this point we should be logged in successfully.
if len(viewer["teams"]["edges"]) > 1:
team_names = [e["node"]["name"] for e in viewer["teams"]["edges"]] + [
"Manual entry"
]
wandb.termlog(
"Which team should we use?",
)
result = util.prompt_choices(team_names)
# result can be empty on click
if result:
entity = result
else:
entity = "Manual Entry"
if entity == "Manual Entry":
entity = click.prompt("Enter the name of the team you want to use")
else:
entity = viewer.get("entity") or click.prompt(
"What username or team should we use?"
)
# TODO: this error handling sucks and the output isn't pretty
try:
project = prompt_for_project(ctx, entity)
except ClickWandbException:
raise ClickException(f"Could not find team: {entity}")
api.set_setting("entity", entity, persist=True)
api.set_setting("project", project, persist=True)
api.set_setting("base_url", api.settings().get("base_url"), persist=True)
filesystem.mkdir_exists_ok(wandb_dir())
with open(os.path.join(wandb_dir(), ".gitignore"), "w") as file:
file.write("*\n!settings")
click.echo(
click.style("This directory is configured! Next, track a run:\n", fg="green")
+ textwrap.dedent(
"""\
* In your training script:
{code1}
{code2}
* then `{run}`.
"""
).format(
code1=click.style("import wandb", bold=True),
code2=click.style(f'wandb.init(project="{project}")', bold=True),
run=click.style("python <train.py>", bold=True),
)
)
@cli.command(
context_settings=CONTEXT, help="Upload an offline training directory to W&B"
)
@click.pass_context
@click.argument("path", nargs=-1, type=click.Path(exists=True))
@click.option("--view", is_flag=True, default=False, help="View runs", hidden=True)
@click.option("--verbose", is_flag=True, default=False, help="Verbose", hidden=True)
@click.option("--id", "run_id", help="The run you want to upload to.")
@click.option("--project", "-p", help="The project you want to upload to.")
@click.option("--entity", "-e", help="The entity to scope to.")
@click.option(
"--job_type",
"job_type",
help="Specifies the type of run for grouping related runs together.",
)
@click.option(
"--sync-tensorboard/--no-sync-tensorboard",
is_flag=True,
default=None,
help="Stream tfevent files to wandb.",
)
@click.option("--include-globs", help="Comma separated list of globs to include.")
@click.option("--exclude-globs", help="Comma separated list of globs to exclude.")
@click.option(
"--include-online/--no-include-online",
is_flag=True,
default=None,
help="Include online runs",
)
@click.option(
"--include-offline/--no-include-offline",
is_flag=True,
default=None,
help="Include offline runs",
)
@click.option(
"--include-synced/--no-include-synced",
is_flag=True,
default=None,
help="Include synced runs",
)
@click.option(
"--mark-synced/--no-mark-synced",
is_flag=True,
default=True,
help="Mark runs as synced",
)
@click.option("--sync-all", is_flag=True, default=False, help="Sync all runs")
@click.option("--clean", is_flag=True, default=False, help="Delete synced runs")
@click.option(
"--clean-old-hours",
default=24,
help="Delete runs created before this many hours. To be used alongside --clean flag.",
type=int,
)
@click.option(
"--clean-force",
is_flag=True,
default=False,
help="Clean without confirmation prompt.",
)
@click.option("--ignore", hidden=True)
@click.option("--show", default=5, help="Number of runs to show")
@click.option("--append", is_flag=True, default=False, help="Append run")
@click.option("--skip-console", is_flag=True, default=False, help="Skip console logs")
@display_error
def sync(
ctx,
path=None,
view=None,
verbose=None,
run_id=None,
project=None,
entity=None,
job_type=None, # trace this back to SyncManager
sync_tensorboard=None,
include_globs=None,
exclude_globs=None,
include_online=None,
include_offline=None,
include_synced=None,
mark_synced=None,
sync_all=None,
ignore=None,
show=None,
clean=None,
clean_old_hours=24,
clean_force=None,
append=None,
skip_console=None,
):
api = _get_cling_api()
if not api.is_authenticated:
wandb.termlog("Login to W&B to sync offline runs")
ctx.invoke(login, no_offline=True)
api = _get_cling_api(reset=True)
if ignore:
exclude_globs = ignore
if include_globs:
include_globs = include_globs.split(",")
if exclude_globs:
exclude_globs = exclude_globs.split(",")
def _summary():
all_items = get_runs(
include_online=True,
include_offline=True,
include_synced=True,
include_unsynced=True,
)
sync_items = get_runs(
include_online=include_online if include_online is not None else True,
include_offline=include_offline if include_offline is not None else True,
include_synced=include_synced if include_synced is not None else False,
include_unsynced=True,
exclude_globs=exclude_globs,
include_globs=include_globs,
)
synced = []
unsynced = []
for item in all_items:
(synced if item.synced else unsynced).append(item)
if sync_items:
wandb.termlog(f"Number of runs to be synced: {len(sync_items)}")
if show and show < len(sync_items):
wandb.termlog(f"Showing {show} runs to be synced:")
for item in sync_items[: (show or len(sync_items))]:
wandb.termlog(f" {item}")
else:
wandb.termlog("No runs to be synced.")
if synced:
clean_cmd = click.style("wandb sync --clean", fg="yellow")
wandb.termlog(
f"NOTE: use {clean_cmd} to delete {len(synced)} synced runs from local directory."
)
if unsynced:
sync_cmd = click.style("wandb sync --sync-all", fg="yellow")
wandb.termlog(
f"NOTE: use {sync_cmd} to sync {len(unsynced)} unsynced runs from local directory."
)
def _sync_path(_path, _sync_tensorboard):
if run_id and len(_path) > 1:
wandb.termerror("id can only be set for a single run.")
sys.exit(1)
sm = SyncManager(
project=project,
entity=entity,
run_id=run_id,
job_type=job_type,
mark_synced=mark_synced,
app_url=api.app_url,
view=view,
verbose=verbose,
sync_tensorboard=_sync_tensorboard,
log_path=_wandb_log_path,
append=append,
skip_console=skip_console,
)
for p in _path:
sm.add(p)
sm.start()
while not sm.is_done():
_ = sm.poll()
def _sync_all():
sync_items = get_runs(
include_online=include_online if include_online is not None else True,
include_offline=include_offline if include_offline is not None else True,
include_synced=include_synced if include_synced is not None else False,
include_unsynced=True,
exclude_globs=exclude_globs,
include_globs=include_globs,
)
if not sync_items:
wandb.termerror("Nothing to sync.")
else:
# When syncing run directories, default to not syncing tensorboard
sync_tb = sync_tensorboard if sync_tensorboard is not None else False
_sync_path(sync_items, sync_tb)
def _clean():
if path:
runs = list(map(get_run_from_path, path))
if not clean_force:
click.confirm(
click.style(
f"Are you sure you want to remove {len(runs)} runs?",
bold=True,
),
abort=True,
)
for run in runs:
shutil.rmtree(run.path)
click.echo(click.style("Success!", fg="green"))
return
runs = get_runs(
include_online=include_online if include_online is not None else True,
include_offline=include_offline if include_offline is not None else True,
include_synced=include_synced if include_synced is not None else True,
include_unsynced=False,
exclude_globs=exclude_globs,
include_globs=include_globs,
)
since = datetime.datetime.now() - datetime.timedelta(hours=clean_old_hours)
old_runs = [run for run in runs if run.datetime < since]
old_runs.sort(key=lambda _run: _run.datetime)
if old_runs:
click.echo(
f"Found {len(runs)} runs, {len(old_runs)} are older than {clean_old_hours} hours"
)
for run in old_runs:
click.echo(run.path)
if not clean_force:
click.confirm(
click.style(
f"Are you sure you want to remove {len(old_runs)} runs?",
bold=True,
),
abort=True,
)
for run in old_runs:
shutil.rmtree(run.path)
click.echo(click.style("Success!", fg="green"))
else:
click.echo(
click.style(
f"No runs older than {clean_old_hours} hours found", fg="red"
)
)
if sync_all:
_sync_all()
elif clean:
_clean()
elif path:
# When syncing a specific path, default to syncing tensorboard
sync_tb = sync_tensorboard if sync_tensorboard is not None else True
_sync_path(path, sync_tb)
else:
_summary()
@cli.command(
context_settings=CONTEXT,
help="Initialize a hyperparameter sweep. Search for hyperparameters that optimizes a cost function of a machine learning model by testing various combinations.",
)
@click.option(
"--project",
"-p",
default=None,
help="""The name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled Uncategorized.""",
)
@click.option(
"--entity",
"-e",
default=None,
help="""The username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity, the run will be sent to your default entity, which is usually your username.""",
)
@click.option("--controller", is_flag=True, default=False, help="Run local controller")
@click.option("--verbose", is_flag=True, default=False, help="Display verbose output")
@click.option(
"--name",
default=None,
help="The name of the sweep. The sweep ID is used if no name is specified.",
)
@click.option("--program", default=None, help="Set sweep program")
@click.option("--settings", default=None, help="Set sweep settings", hidden=True)
@click.option("--update", default=None, help="Update pending sweep")
@click.option(
"--stop",
is_flag=True,
default=False,
help="Finish a sweep to stop running new runs and let currently running runs finish.",
)
@click.option(
"--cancel",
is_flag=True,
default=False,
help="Cancel a sweep to kill all running runs and stop running new runs.",
)
@click.option(
"--pause",
is_flag=True,
default=False,
help="Pause a sweep to temporarily stop running new runs.",
)
@click.option(
"--resume",
is_flag=True,
default=False,
help="Resume a sweep to continue running new runs.",
)
@click.option(
"--prior_run",
"-R",
"prior_runs",
multiple=True,
default=None,
help="ID of an existing run to add to this sweep",
)
@click.argument("config_yaml_or_sweep_id")
@click.pass_context
@display_error
def sweep(
ctx,
project,
entity,
controller,
verbose,
name,
program,
settings,
update,
stop,
cancel,
pause,
resume,
prior_runs,
config_yaml_or_sweep_id,
):
state_args = "stop", "cancel", "pause", "resume"
lcls = locals()
is_state_change_command = sum(lcls[k] for k in state_args)
if is_state_change_command > 1:
raise Exception("Only one state flag (stop/cancel/pause/resume) is allowed.")
elif is_state_change_command == 1:
sweep_id = config_yaml_or_sweep_id
api = _get_cling_api()
if not api.is_authenticated:
wandb.termlog("Login to W&B to use the sweep feature")
ctx.invoke(login, no_offline=True)
api = _get_cling_api(reset=True)
parts = dict(entity=entity, project=project, name=sweep_id)
err = sweep_utils.parse_sweep_id(parts)
if err:
wandb.termerror(err)
return
entity = parts.get("entity") or entity
project = parts.get("project") or project
sweep_id = parts.get("name") or sweep_id
state = [s for s in state_args if lcls[s]][0]
ings = {
"stop": "Stopping",
"cancel": "Cancelling",
"pause": "Pausing",
"resume": "Resuming",
}
wandb.termlog(f"{ings[state]} sweep {entity}/{project}/{sweep_id}")
getattr(api, f"{state}_sweep")(sweep_id, entity=entity, project=project)
wandb.termlog("Done.")
return
else:
config_yaml = config_yaml_or_sweep_id
def _parse_settings(settings):
"""Parse settings from json or comma separated assignments."""
ret = {}
# TODO(jhr): merge with magic:_parse_magic
if settings.find("=") > 0:
for item in settings.split(","):
kv = item.split("=")
if len(kv) != 2:
wandb.termwarn(
"Unable to parse sweep settings key value pair", repeat=False
)
ret.update(dict([kv]))
return ret
wandb.termwarn("Unable to parse settings parameter", repeat=False)
return ret
api = _get_cling_api()
if not api.is_authenticated:
wandb.termlog("Login to W&B to use the sweep feature")
ctx.invoke(login, no_offline=True)
api = _get_cling_api(reset=True)
sweep_obj_id = None
if update:
parts = dict(entity=entity, project=project, name=update)
err = sweep_utils.parse_sweep_id(parts)
if err:
wandb.termerror(err)
return
entity = parts.get("entity") or entity
project = parts.get("project") or project
sweep_id = parts.get("name") or update
has_project = (project or api.settings("project")) is not None
has_entity = (entity or api.settings("entity")) is not None
termerror_msg = (
"Sweep lookup requires a valid %s, and none was specified. \n"
"Either set a default %s in wandb/settings, or, if invoking \n`wandb sweep` "
"from the command line, specify the full sweep path via: \n\n"
" wandb sweep {username}/{projectname}/{sweepid}\n\n"
)
if not has_entity:
wandb.termerror(termerror_msg % (("entity",) * 2))
return
if not has_project:
wandb.termerror(termerror_msg % (("project",) * 2))
return
found = api.sweep(sweep_id, "{}", entity=entity, project=project)
if not found:
wandb.termerror(f"Could not find sweep {entity}/{project}/{sweep_id}")
return
sweep_obj_id = found["id"]
action = "Updating" if sweep_obj_id else "Creating"
wandb.termlog(f"{action} sweep from: {config_yaml}")
config = sweep_utils.load_sweep_config(config_yaml)
# Set or override parameters
if name:
config["name"] = name
if program:
config["program"] = program
if settings:
settings = _parse_settings(settings)
if settings:
config.setdefault("settings", {})
config["settings"].update(settings)
if controller:
config.setdefault("controller", {})
config["controller"]["type"] = "local"
is_local = config.get("controller", {}).get("type") == "local"
if is_local:
from wandb import controller as wandb_controller
tuner = wandb_controller()
err = tuner._validate(config)
if err:
wandb.termerror(f"Error in sweep file: {err}")
return
env = os.environ
entity = (
entity
or env.get("WANDB_ENTITY")
or config.get("entity")
or api.settings("entity")
)
project = (
project
or env.get("WANDB_PROJECT")
or config.get("project")
or api.settings("project")
or util.auto_project_name(config.get("program"))
)
sweep_id, warnings = api.upsert_sweep(
config,
project=project,
entity=entity,
obj_id=sweep_obj_id,
prior_runs=prior_runs,
)
sweep_utils.handle_sweep_config_violations(warnings)
# Log nicely formatted sweep information
styled_id = click.style(sweep_id, fg="yellow")
wandb.termlog(f"{action} sweep with ID: {styled_id}")
sweep_url = wandb_sdk.wandb_sweep._get_sweep_url(api, sweep_id)
if sweep_url:
styled_url = click.style(sweep_url, underline=True, fg="blue")
wandb.termlog(f"View sweep at: {styled_url}")
# re-probe entity and project if it was auto-detected by upsert_sweep
entity = entity or env.get("WANDB_ENTITY")
project = project or env.get("WANDB_PROJECT")
if entity and project:
sweep_path = f"{entity}/{project}/{sweep_id}"
elif project:
sweep_path = f"{project}/{sweep_id}"
else:
sweep_path = sweep_id
if sweep_path.find(" ") >= 0:
sweep_path = f"{sweep_path!r}"
styled_path = click.style(f"wandb agent {sweep_path}", fg="yellow")
wandb.termlog(f"Run sweep agent with: {styled_path}")
if controller:
wandb.termlog("Starting wandb controller...")
from wandb import controller as wandb_controller
tuner = wandb_controller(sweep_id)
tuner.run(verbose=verbose)
@cli.command(
context_settings=CONTEXT,
no_args_is_help=True,
help="Run a W&B launch sweep (Experimental).",
)
@click.option(
"--queue",
"-q",
default=None,
help="The name of a queue to push the sweep to",
)
@click.option(
"--project",
"-p",
default=None,
help="Name of the project which the agent will watch. "
"If passed in, will override the project value passed in using a config file",
)
@click.option(
"--entity",
"-e",
default=None,
help="The entity to use. Defaults to current logged-in user",
)
@click.option(
"--resume_id",
"-r",
default=None,
help="Resume a launch sweep by passing an 8-char sweep id. Queue required",
)
@click.option(
"--prior_run",
"-R",
"prior_runs",
multiple=True,
default=None,
help="ID of an existing run to add to this sweep",
)
@click.argument("config", required=False, type=click.Path(exists=True))
@click.pass_context
@display_error
def launch_sweep(
ctx,
project,
entity,
queue,
config,
resume_id,
prior_runs,
):
api = _get_cling_api()
env = os.environ
if not api.is_authenticated:
wandb.termlog("Login to W&B to use the sweep feature")
ctx.invoke(login, no_offline=True)
api = _get_cling_api(reset=True)
entity = entity or env.get("WANDB_ENTITY") or api.settings("entity")
if entity is None:
wandb.termerror("Must specify entity when using launch")
return
project = project or env.get("WANDB_PROJECT") or api.settings("project")
if project is None:
wandb.termerror("A project must be configured when using launch")
return
# get personal username, not team name or service account, default to entity
author = api.viewer().get("username") or entity
# if not sweep_config XOR resume_id
if not (config or resume_id):
wandb.termerror("'config' and/or 'resume_id' required")
return
parsed_user_config = sweep_utils.load_launch_sweep_config(config)
# Rip special keys out of config, store in scheduler run_config
launch_args: Dict[str, Any] = parsed_user_config.pop("launch", {})
scheduler_args: Dict[str, Any] = parsed_user_config.pop("scheduler", {})
settings: Dict[str, Any] = scheduler_args.pop("settings", {})
scheduler_job: Optional[str] = scheduler_args.get("job")
if scheduler_job:
wandb.termwarn(
"Using a scheduler job for launch sweeps is *experimental* and may change without warning"
)
queue: Optional[str] = queue or launch_args.get("queue")
sweep_config, sweep_obj_id = None, None
if not resume_id:
sweep_config = parsed_user_config
# check method
method = sweep_config.get("method")
if scheduler_job and not method:
sweep_config["method"] = "custom"
elif scheduler_job and method != "custom":
# TODO(gst): Check if using Anaconda2
wandb.termwarn(
"Use 'method': 'custom' in the sweep config when using scheduler jobs, "
"or omit it entirely. For jobs using the wandb optimization engine (WandbScheduler), "
"set the method in the sweep config under scheduler.settings.method "
)
settings["method"] = method
if settings.get("method"):
# assume WandbScheduler, and user is using this right
sweep_config["method"] = settings["method"]
else: # Resuming an existing sweep
found = api.sweep(resume_id, "{}", entity=entity, project=project)
if not found:
wandb.termerror(f"Could not find sweep {entity}/{project}/{resume_id}")
return
if found.get("state") == "RUNNING":
wandb.termerror(
f"Cannot resume sweep {entity}/{project}/{resume_id}, it is already running"
)
return
sweep_obj_id = found["id"]
sweep_config = yaml.safe_load(found["config"])
wandb.termlog(f"Resuming from existing sweep {entity}/{project}/{resume_id}")
if len(parsed_user_config.keys()) > 0:
wandb.termwarn(
"Sweep parameters loaded from resumed sweep, ignoring provided config"
)
prev_scheduler = json.loads(found.get("scheduler") or "{}")
run_spec = json.loads(prev_scheduler.get("run_spec", "{}"))
if (
scheduler_job
and run_spec.get("job")
and run_spec.get("job") != scheduler_job
):
wandb.termerror(
f"Resuming a launch sweep with a different scheduler job is not supported. Job loaded from sweep: {run_spec.get('job')}, job in config: {scheduler_job}"
)
return
prev_scheduler_args, prev_settings = sweep_utils.get_previous_args(run_spec)
# Passed in scheduler_args and settings override previous
scheduler_args.update(prev_scheduler_args)
settings.update(prev_settings)
if not queue:
wandb.termerror(
"Launch-sweeps require setting a 'queue', use --queue option or a 'queue' key in the 'launch' section in the config"
)
return
entrypoint = Scheduler.ENTRYPOINT if not scheduler_job else None
args = sweep_utils.construct_scheduler_args(
return_job=scheduler_job is not None,
sweep_config=sweep_config,
queue=queue,
project=project,
author=author,
)
if not args:
return
# validate training job existence
if not sweep_utils.check_job_exists(PublicApi(), sweep_config.get("job")):
return False
# validate scheduler job existence, if present
if not sweep_utils.check_job_exists(PublicApi(), scheduler_job):
return False
# Set run overrides for the Scheduler
overrides = {"run_config": {}}
if launch_args:
overrides["run_config"]["launch"] = launch_args
if scheduler_args:
overrides["run_config"]["scheduler"] = scheduler_args
if settings:
overrides["run_config"]["settings"] = settings
if scheduler_job:
overrides["run_config"]["sweep_args"] = args
else:
overrides["args"] = args
# configure scheduler job resource
resource = scheduler_args.get("resource")
if resource:
if resource == "local-process" and scheduler_job:
wandb.termerror(
"Scheduler jobs cannot be run with the 'local-process' resource"
)
return
if resource == "local-process" and scheduler_args.get("docker_image"):
wandb.termerror(
"Scheduler jobs cannot be run with the 'local-process' resource and a docker image"
)
return
else: # no resource set, default local-process if not scheduler job, else container
resource = "local-process" if not scheduler_job else "local-container"
# Launch job spec for the Scheduler
launch_scheduler_spec = launch_utils.construct_launch_spec(
uri=Scheduler.PLACEHOLDER_URI,
api=api,
name="Scheduler.WANDB_SWEEP_ID",
project=project,
entity=entity,
docker_image=scheduler_args.get("docker_image"),
resource=resource,
entry_point=entrypoint,
resource_args=scheduler_args.get("resource_args", {}),
repository=launch_args.get("registry", {}).get("url", None),
job=scheduler_job,
version=None,
launch_config={"overrides": overrides},
run_id="WANDB_SWEEP_ID", # scheduler inits run with sweep_id=run_id
author=None, # author gets passed into scheduler override args
)
launch_scheduler_with_queue = json.dumps(
{
"queue": queue,
"run_queue_project": launch_utils.LAUNCH_DEFAULT_PROJECT,
"run_spec": json.dumps(launch_scheduler_spec),
}
)
sweep_id, warnings = api.upsert_sweep(
sweep_config,
project=project,
entity=entity,
obj_id=sweep_obj_id, # if resuming
launch_scheduler=launch_scheduler_with_queue,
state="PENDING",
prior_runs=prior_runs,
template_variable_values=scheduler_args.get("template_variables", None),
)
sweep_utils.handle_sweep_config_violations(warnings)
# Log nicely formatted sweep information
styled_id = click.style(sweep_id, fg="yellow")
wandb.termlog(f"{'Resumed' if resume_id else 'Created'} sweep with ID: {styled_id}")
sweep_url = wandb_sdk.wandb_sweep._get_sweep_url(api, sweep_id)
if sweep_url:
styled_url = click.style(sweep_url, underline=True, fg="blue")
wandb.termlog(f"View sweep at: {styled_url}")
wandb.termlog(f"Scheduler added to launch queue ({queue})")
@cli.command(help=f"Launch or queue a W&B Job. See {url_registry.url('wandb-launch')}")
@click.option(
"--uri",
"-u",
metavar="(str)",
default=None,
help="Local path or git repo uri to launch. If provided this command will "
"create a job from the specified uri.",
)
@click.option(
"--job",
"-j",
metavar="(str)",
default=None,
help="Name of the job to launch. If passed in, launch does not require a uri.",
)
@click.option(
"--entry-point",
"-E",
metavar="NAME",
default=None,
help="""Entry point within project. [default: main]. If the entry point is not found,
attempts to run the project file with the specified name as a script,
using 'python' to run .py files and the default shell (specified by
environment variable $SHELL) to run .sh files. If passed in, will override the entrypoint value passed in using a config file.""",
)
@click.option(
"--git-version",
"-g",
metavar="GIT-VERSION",
hidden=True,
help="Version of the project to run, as a Git commit reference for Git projects.",
)
@click.option(
"--build-context",
metavar="(str)",
help="Path to the build context within the source code. Defaults to the "
"root of the source code. Compatible only with -u.",
)
@click.option(
"--job-name",
"-J",
metavar="(str)",
default=None,
hidden=True,
help="Name for the job created if the -u,--uri flag is passed in.",
)
@click.option(
"--name",
envvar="WANDB_NAME",
help="""Name of the run under which to launch the run. If not
specified, a random run name will be used to launch run. If passed in, will override the name passed in using a config file.""",
)
@click.option(
"--entity",
"-e",
metavar="(str)",
default=None,
help="""Name of the target entity which the new run will be sent to. Defaults to using the entity set by local wandb/settings folder.
If passed in, will override the entity value passed in using a config file.""",
)
@click.option(
"--project",
"-p",
metavar="(str)",
default=None,
help="""Name of the target project which the new run will be sent to. Defaults to using the project name given by the source uri
or for github runs, the git repo name. If passed in, will override the project value passed in using a config file.""",
)
@click.option(
"--resource",
"-r",
metavar="BACKEND",
default=None,
help="""Execution resource to use for run. Supported values: 'local-process', 'local-container', 'kubernetes', 'sagemaker', 'gcp-vertex'.
This is now a required parameter if pushing to a queue with no resource configuration.
If passed in, will override the resource value passed in using a config file.""",
)
@click.option(
"--docker-image",
"-d",
default=None,
metavar="DOCKER IMAGE",
help="""Specific docker image you'd like to use. In the form name:tag.
If passed in, will override the docker image value passed in using a config file.""",
)
@click.option(
"--base-image",
"-B",
default=None,
metavar="BASE IMAGE",
help="""Docker image to run job code in. Incompatible with --docker-image.""",
)
@click.option(
"--config",
"-c",
metavar="FILE",
help="""Path to JSON file (must end in '.json') or JSON string which will be passed
as a launch config. Dictation how the launched run will be configured.""",
)
@click.option(
"--set-var",
"-v",
"cli_template_vars",
default=None,
multiple=True,
help="""Set template variable values for queues with allow listing enabled,
as key-value pairs e.g. `--set-var key1=value1 --set-var key2=value2`""",
)
@click.option(
"--queue",
"-q",
is_flag=False,
flag_value="default",
default=None,
help="""Name of run queue to push to. If none, launches single run directly. If supplied without
an argument (`--queue`), defaults to queue 'default'. Else, if name supplied, specified run queue must exist under the
project and entity supplied.""",
)
@click.option(
"--async",
"run_async",
is_flag=True,
help="""Flag to run the job asynchronously. Defaults to false, i.e. unless --async is set, wandb launch will wait for
the job to finish. This option is incompatible with --queue; asynchronous options when running with an agent should be
set on wandb launch-agent.""",
)
@click.option(
"--resource-args",
"-R",
metavar="FILE",
help="""Path to JSON file (must end in '.json') or JSON string which will be passed
as resource args to the compute resource. The exact content which should be
provided is different for each execution backend. See documentation for layout of this file.""",
)
@click.option(
"--build",
"-b",
is_flag=True,
hidden=True,
help="Flag to build an associated job and push to queue as an image job.",
)
@click.option(
"--repository",
"-rg",
is_flag=False,
default=None,
hidden=True,
help="Name of a remote repository. Will be used to push a built image to.",
)
# TODO: this is only included for back compat. But we should remove this in the future
@click.option(
"--project-queue",
"-pq",
default=None,
hidden=True,
help="Name of the project containing the queue to push to. If none, defaults to entity level queues.",
)
@click.option(
"--dockerfile",
"-D",
default=None,
help="Path to the Dockerfile used to build the job, relative to the job's root",
)
@click.option(
"--priority",
"-P",
default=None,
type=click.Choice(["critical", "high", "medium", "low"]),
help="""When --queue is passed, set the priority of the job. Launch jobs with higher priority
are served first. The order, from highest to lowest priority, is: critical, high, medium, low""",
)
@display_error
def launch(
uri,
job,
entry_point,
git_version,
build_context,
name,
resource,
entity,
project,
docker_image,
base_image,
config,
cli_template_vars,
queue,
run_async,
resource_args,
build,
repository,
project_queue,
dockerfile,
priority,
job_name,
):
"""Start a W&B run from the given URI.
The URI can bea wandb URI, a GitHub repo uri, or a local path). In the case of a
wandb URI the arguments used in the original run will be used by default. These
arguments can be overridden using the args option, or specifying those arguments in
the config's 'overrides' key, 'args' field as a list of strings.
Running `wandb launch [URI]` will launch the run directly. To add the run to a
queue, run `wandb launch [URI] --queue [optional queuename]`.
"""
logger.info(
f"=== Launch called with kwargs {locals()} CLI Version: {wandb.__version__}==="
)
from wandb.sdk.launch._launch import _launch
from wandb.sdk.launch.create_job import _create_job
from wandb.sdk.launch.utils import _is_git_uri
api = _get_cling_api()
wandb._sentry.configure_scope(process_context="launch_cli")
if run_async and queue is not None:
raise LaunchError(
"Cannot use both --async and --queue with wandb launch, see help for details."
)
if queue and docker_image and not project:
raise LaunchError(
"Cannot use --queue and --docker together without a project. Please specify a project with --project or -p."
)
if priority is not None and queue is None:
raise LaunchError("--priority flag requires --queue to be set")
if resource_args is not None:
resource_args = util.load_json_yaml_dict(resource_args)
if resource_args is None:
raise LaunchError("Invalid format for resource-args")
else:
resource_args = {}
if entry_point is not None:
entry_point = shlex.split(entry_point)
if config is not None:
config = util.load_json_yaml_dict(config)
if config is None:
raise LaunchError("Invalid format for config")
else:
config = {}
resource = resource or config.get("resource")
if build and queue is None:
raise LaunchError("Build flag requires a queue to be set")
try:
launch_utils.check_logged_in(api)
except Exception:
wandb.termerror(f"Error running job: {traceback.format_exc()}")
run_id = config.get("run_id")
# If URI was provided, we need to create a job from it.
if uri:
if entry_point is None:
raise LaunchError(
"Cannot provide a uri without an entry point. Please provide an "
"entry point with --entry-point or -E."
)
if job is not None:
raise LaunchError("Cannot provide both a uri and a job name.")
job_type = (
"git" if _is_git_uri(uri) else "code"
) # TODO: Add support for local URIs with git.
if entity is None:
entity = launch_utils.get_default_entity(api, config)
artifact, _, _ = _create_job(
api,
job_type,
uri,
entrypoint=" ".join(entry_point),
git_hash=git_version,
name=job_name,
project=project,
base_image=base_image,
build_context=build_context,
dockerfile=dockerfile,
entity=entity,
)
if artifact is None:
raise LaunchError(f"Failed to create job from uri: {uri}")
job = f"{entity}/{project}/{artifact.name}"
if dockerfile:
if "overrides" in config:
config["overrides"]["dockerfile"] = dockerfile
else:
config["overrides"] = {"dockerfile": dockerfile}
if priority is not None:
priority_map = {
"critical": 0,
"high": 1,
"medium": 2,
"low": 3,
}
priority = priority_map[priority.lower()]
template_variables = None
if cli_template_vars:
if queue is None:
raise LaunchError("'--set-var' flag requires queue to be set")
if entity is None:
entity = launch_utils.get_default_entity(api, config)
public_api = PublicApi()
runqueue = RunQueue(client=public_api.client, name=queue, entity=entity)
template_variables = launch_utils.fetch_and_validate_template_variables(
runqueue, cli_template_vars
)
if queue is None:
# direct launch
try:
run = asyncio.run(
_launch(
api,
job,
project=project,
entity=entity,
docker_image=docker_image,
name=name,
entry_point=entry_point,
version=git_version,
resource=resource,
resource_args=resource_args,
launch_config=config,
synchronous=(not run_async),
run_id=run_id,
repository=repository,
)
)
if asyncio.run(run.get_status()).state in [
"failed",
"stopped",
"preempted",
]:
wandb.termerror("Launched run exited with non-zero status")
sys.exit(1)
except LaunchError as e:
logger.exception("An error occurred.")
wandb._sentry.exception(e)
sys.exit(e)
except ExecutionError as e:
logger.exception("An error occurred.")
wandb._sentry.exception(e)
sys.exit(e)
except asyncio.CancelledError:
sys.exit(0)
else:
try:
_launch_add(
api,
job,
config,
template_variables,
project,
entity,
queue,
resource,
entry_point,
name,
git_version,
docker_image,
project_queue,
resource_args,
build=build,
run_id=run_id,
repository=repository,
priority=priority,
)
except Exception as e:
wandb._sentry.exception(e)
raise
@cli.command(
context_settings=CONTEXT,
help="Run a W&B launch agent.",
)
@click.pass_context
@click.option(
"--queue",
"-q",
"queues",
default=None,
multiple=True,
help="The name of a queue for the agent to watch. Multiple -q flags supported.",
)
@click.option(
"--entity",
"-e",
default=None,
help="The entity to use. Defaults to current logged-in user",
)
@click.option(
"--log-file",
"-l",
default=None,
help=(
"Destination for internal agent logs. Use - for stdout. "
"By default all agents logs will go to debug.log in your wandb/ "
"subdirectory or WANDB_DIR if set."
),
)
@click.option(
"--max-jobs",
"-j",
default=None,
help="The maximum number of launch jobs this agent can run in parallel. Defaults to 1. Set to -1 for no upper limit",
)
@click.option(
"--config", "-c", default=None, help="path to the agent config yaml to use"
)
@click.option(
"--url",
"-u",
default=None,
hidden=True,
help="a wandb client registration URL, this is generated in the UI",
)
@click.option("--verbose", "-v", count=True, help="Display verbose output")
@display_error
def launch_agent(
ctx,
entity=None,
queues=None,
max_jobs=None,
config=None,
url=None,
log_file=None,
verbose=0,
):
logger.info(
f"=== Launch-agent called with kwargs {locals()} CLI Version: {wandb.__version__} ==="
)
if url is not None:
raise LaunchError(
"--url is not supported in this version, upgrade with: pip install -u wandb"
)
import wandb.sdk.launch._launch as _launch
if log_file is not None:
_launch.set_launch_logfile(log_file)
api = _get_cling_api()
wandb._sentry.configure_scope(process_context="launch_agent")
agent_config, api = _launch.resolve_agent_config(
entity, max_jobs, queues, config, verbose
)
if len(agent_config.get("queues")) == 0:
raise LaunchError(
"To launch an agent please specify a queue or a list of queues in the configuration file or cli."
)
launch_utils.check_logged_in(api)
wandb.termlog("Starting launch agent β¨")
try:
_launch.create_and_run_agent(api, agent_config)
except Exception as e:
wandb._sentry.exception(e)
raise
@cli.command(context_settings=CONTEXT, help="Run the W&B agent")
@click.pass_context
@click.option(
"--project",
"-p",
default=None,
help="""The name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled 'Uncategorized'.""",
)
@click.option(
"--entity",
"-e",
default=None,
help="""The username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity, the run will be sent to your default entity, which is usually your username.""",
)
@click.option(
"--count", default=None, type=int, help="The max number of runs for this agent."
)
@click.argument("sweep_id")
@display_error
def agent(ctx, project, entity, count, sweep_id):
api = _get_cling_api()
if not api.is_authenticated:
wandb.termlog("Login to W&B to use the sweep agent feature")
ctx.invoke(login, no_offline=True)
api = _get_cling_api(reset=True)
wandb.termlog("Starting wandb agent π΅οΈ")
wandb_agent.agent(sweep_id, entity=entity, project=project, count=count)
# you can send local commands like so:
# agent_api.command({'type': 'run', 'program': 'train.py',
# 'args': ['--max_epochs=10']})
@cli.command(
context_settings=RUN_CONTEXT, help="Run a W&B launch sweep scheduler (Experimental)"
)
@click.pass_context
@click.argument("sweep_id")
@display_error
def scheduler(
ctx,
sweep_id,
):
api = InternalApi()
if not api.is_authenticated:
wandb.termlog("Login to W&B to use the sweep scheduler feature")
ctx.invoke(login, no_offline=True)
api = InternalApi(reset=True)
wandb._sentry.configure_scope(process_context="sweep_scheduler")
wandb.termlog("Starting a Launch Scheduler π")
from wandb.sdk.launch.sweeps import load_scheduler
# TODO(gst): remove this monstrosity
# Future-proofing hack to pull any kwargs that get passed in through the CLI
kwargs = {}
for i, _arg in enumerate(ctx.args):
if isinstance(_arg, str) and _arg.startswith("--"):
# convert input kwargs from hyphens to underscores
_key = _arg[2:].replace("-", "_")
_args = ctx.args[i + 1]
if str.isdigit(_args):
_args = int(_args)
kwargs[_key] = _args
try:
sweep_type = kwargs.get("sweep_type", "wandb")
_scheduler = load_scheduler(scheduler_type=sweep_type)(
api,
sweep_id=sweep_id,
**kwargs,
)
_scheduler.start()
except Exception as e:
wandb._sentry.exception(e)
raise
@cli.group(help="Commands for managing and viewing W&B jobs")
def job() -> None:
pass
@job.command("list", help="List jobs in a project")
@click.option(
"--project",
"-p",
envvar=env.PROJECT,
help="The project you want to list jobs from.",
)
@click.option(
"--entity",
"-e",
default="models",
envvar=env.ENTITY,
help="The entity the jobs belong to",
)
def _list(project, entity):
wandb.termlog(f"Listing jobs in {entity}/{project}")
public_api = PublicApi()
try:
jobs = public_api.list_jobs(entity=entity, project=project)
except wandb.errors.CommError as e:
wandb.termerror(f"{e}")
return
if len(jobs) == 0:
wandb.termlog("No jobs found")
return
for job in jobs:
aliases = []
if len(job["edges"]) == 0:
# deleted?
continue
name = job["edges"][0]["node"]["artifactSequence"]["name"]
for version in job["edges"]:
aliases += [x["alias"] for x in version["node"]["aliases"]]
# only list the most recent 10 job versions
aliases_str = ",".join(aliases[::-1])
wandb.termlog(f"{name} -- versions ({len(aliases)}): {aliases_str}")
@job.command(
help="Describe a launch job. Provide the launch job in the form of: entity/project/job-name:alias-or-version"
)
@click.argument("job")
def describe(job):
public_api = PublicApi()
try:
job = public_api.job(name=job)
except wandb.errors.CommError as e:
wandb.termerror(f"{e}")
return
for key in job._job_info:
if key.startswith("_"):
continue
wandb.termlog(f"{key}: {job._job_info[key]}")
@job.command(
no_args_is_help=True,
)
@click.option(
"--project",
"-p",
envvar=env.PROJECT,
help="The project you want to list jobs from.",
)
@click.option(
"--entity",
"-e",
envvar=env.ENTITY,
help="The entity the jobs belong to",
)
@click.option(
"--name",
"-n",
help="Name for the job",
)
@click.option(
"--description",
"-d",
help="Description for the job",
)
@click.option(
"--alias",
"-a",
"aliases",
help="Alias for the job",
multiple=True,
default=tuple(),
)
@click.option(
"--entry-point",
"-E",
"entrypoint",
help="Entrypoint to the script, including an executable and an entrypoint "
"file. Required for code or repo jobs. If --build-context is provided, "
"paths in the entrypoint command will be relative to the build context.",
)
@click.option(
"--git-hash",
"-g",
"git_hash",
type=str,
help="Commit reference to use as the source for git jobs",
)
@click.option(
"--runtime",
"-r",
type=str,
help="Python runtime to execute the job",
)
@click.option(
"--build-context",
"-b",
type=str,
help="Path to the build context from the root of the job source code. If "
"provided, this is used as the base path for the Dockerfile and entrypoint.",
)
@click.option(
"--base-image",
"-B",
type=str,
help="Base image to use for the job. Incompatible with image jobs.",
)
@click.option(
"--dockerfile",
"-D",
type=str,
help="Path to the Dockerfile for the job. If --build-context is provided, "
"the Dockerfile path will be relative to the build context.",
)
@click.argument(
"job_type",
type=click.Choice(("git", "code", "image")),
)
@click.argument("path")
def create(
path,
project,
entity,
name,
job_type,
description,
aliases,
entrypoint,
git_hash,
runtime,
build_context,
base_image,
dockerfile,
):
"""Create a job from a source, without a wandb run.
Jobs can be of three types, git, code, or image.
git: A git source, with an entrypoint either in the path or provided explicitly pointing to the main python executable.
code: A code path, containing a requirements.txt file.
image: A docker image.
"""
from wandb.sdk.launch.create_job import _create_job
api = _get_cling_api()
wandb._sentry.configure_scope(process_context="job_create")
entity = entity or os.getenv("WANDB_ENTITY") or api.default_entity
if not entity:
wandb.termerror("No entity provided, use --entity or set WANDB_ENTITY")
return
project = project or os.getenv("WANDB_PROJECT")
if not project:
wandb.termerror("No project provided, use --project or set WANDB_PROJECT")
return
if entrypoint is None and job_type in ["git", "code"]:
wandb.termwarn(
f"No entrypoint provided for {job_type} job, defaulting to main.py"
)
entrypoint = "main.py"
if job_type == "image" and base_image:
wandb.termerror("Cannot provide --base-image/-B for an `image` job")
return
artifact, action, aliases = _create_job(
api=api,
path=path,
entity=entity,
project=project,
name=name,
job_type=job_type,
description=description,
aliases=list(aliases),
entrypoint=entrypoint,
git_hash=git_hash,
runtime=runtime,
build_context=build_context,
base_image=base_image,
dockerfile=dockerfile,
)
if not artifact:
wandb.termerror("Job creation failed")
return
artifact_path = f"{entity}/{project}/{artifact.name}"
msg = f"{action} job: {click.style(artifact_path, fg='yellow')}"
if len(aliases) == 1:
alias_str = click.style(aliases[0], fg="yellow")
msg += f", with alias: {alias_str}"
elif len(aliases) > 1:
alias_str = click.style(", ".join(aliases), fg="yellow")
msg += f", with aliases: {alias_str}"
wandb.termlog(msg)
web_url = util.app_url(api.settings().get("base_url"))
url = click.style(f"{web_url}/{entity}/{project}/jobs", underline=True)
wandb.termlog(f"View all jobs in project '{project}' here: {url}\n")
@cli.command(context_settings=CONTEXT, help="Run the W&B local sweep controller")
@click.option("--verbose", is_flag=True, default=False, help="Display verbose output")
@click.argument("sweep_id")
@display_error
def controller(verbose, sweep_id):
click.echo("Starting wandb controller...")
from wandb import controller as wandb_controller
tuner = wandb_controller(sweep_id)
tuner.run(verbose=verbose)
@cli.command(context_settings=RUN_CONTEXT, name="docker-run")
@click.pass_context
@click.argument("docker_run_args", nargs=-1)
def docker_run(ctx, docker_run_args):
"""Wrap `docker run` and adds WANDB_API_KEY and WANDB_DOCKER environment variables.
This will also set the runtime to nvidia if the nvidia-docker executable is present
on the system and --runtime wasn't set.
See `docker run --help` for more details.
"""
import wandb.docker
api = InternalApi()
args = list(docker_run_args)
if len(args) > 0 and args[0] == "run":
args.pop(0)
if len([a for a in args if a.startswith("--runtime")]) == 0 and _HAS_NVIDIA_DOCKER:
args = ["--runtime", "nvidia"] + args
# TODO: image_from_docker_args uses heuristics to find the docker image arg, there are likely cases
# where this won't work
image = util.image_from_docker_args(args)
resolved_image = None
if image:
resolved_image = wandb.docker.image_id(image)
if resolved_image:
args = ["-e", f"WANDB_DOCKER={resolved_image}"] + args
else:
wandb.termlog(
"Couldn't detect image argument, running command without the WANDB_DOCKER env variable"
)
if api.api_key:
args = ["-e", f"WANDB_API_KEY={api.api_key}"] + args
else:
wandb.termlog(
"Not logged in, run `wandb login` from the host machine to enable result logging"
)
subprocess.call(["docker", "run"] + args)
@cli.command(context_settings=RUN_CONTEXT)
@click.pass_context
@click.argument("docker_run_args", nargs=-1)
@click.argument("docker_image", required=False)
@click.option(
"--nvidia/--no-nvidia",
default=_HAS_NVIDIA_DOCKER,
help="Use the nvidia runtime, defaults to nvidia if nvidia-docker is present",
)
@click.option(
"--digest", is_flag=True, default=False, help="Output the image digest and exit"
)
@click.option(
"--jupyter/--no-jupyter", default=False, help="Run jupyter lab in the container"
)
@click.option(
"--dir", default="/app", help="Which directory to mount the code in the container"
)
@click.option("--no-dir", is_flag=True, help="Don't mount the current directory")
@click.option(
"--shell", default="/bin/bash", help="The shell to start the container with"
)
@click.option("--port", default="8888", help="The host port to bind jupyter on")
@click.option("--cmd", help="The command to run in the container")
@click.option(
"--no-tty", is_flag=True, default=False, help="Run the command without a tty"
)
@display_error
def docker(
ctx,
docker_run_args,
docker_image,
nvidia,
digest,
jupyter,
dir,
no_dir,
shell,
port,
cmd,
no_tty,
):
"""Run your code in a docker container.
W&B docker lets you run your code in a docker image ensuring wandb is configured. It
adds the WANDB_DOCKER and WANDB_API_KEY environment variables to your container and
mounts the current directory in /app by default. You can pass additional args which
will be added to `docker run` before the image name is declared, we'll choose a
default image for you if one isn't passed:
```sh
wandb docker -v /mnt/dataset:/app/data
wandb docker gcr.io/kubeflow-images-public/tensorflow-1.12.0-notebook-cpu:v0.4.0 --jupyter
wandb docker wandb/deepo:keras-gpu --no-tty --cmd "python train.py --epochs=5"
```
By default, we override the entrypoint to check for the existence of wandb and
install it if not present. If you pass the --jupyter flag we will ensure jupyter is
installed and start jupyter lab on port 8888. If we detect nvidia-docker on your
system we will use the nvidia runtime. If you just want wandb to set environment
variable to an existing docker run command, see the wandb docker-run command.
"""
api = InternalApi()
if not _HAS_DOCKER:
raise ClickException("Docker not installed, install it from https://docker.com")
import wandb.docker
args = list(docker_run_args)
image = docker_image or ""
# remove run for users used to nvidia-docker
if len(args) > 0 and args[0] == "run":
args.pop(0)
if image == "" and len(args) > 0:
image = args.pop(0)
# If the user adds docker args without specifying an image (should be rare)
if not util.docker_image_regex(image.split("@")[0]):
if image:
args = args + [image]
image = wandb.docker.default_image(gpu=nvidia)
subprocess.call(["docker", "pull", image])
_, repo_name, tag = wandb.docker.parse(image)
resolved_image = wandb.docker.image_id(image)
if resolved_image is None:
raise ClickException(
f"Couldn't find image locally or in a registry, try running `docker pull {image}`"
)
if digest:
sys.stdout.write(resolved_image)
exit(0)
existing = wandb.docker.shell(["ps", "-f", f"ancestor={resolved_image}", "-q"])
if existing:
if click.confirm(
"Found running container with the same image, do you want to attach?"
):
subprocess.call(["docker", "attach", existing.split("\n")[0]])
exit(0)
cwd = os.getcwd()
command = [
"docker",
"run",
"-e",
"LANG=C.UTF-8",
"-e",
f"WANDB_DOCKER={resolved_image}",
"--ipc=host",
"-v",
wandb.docker.entrypoint + ":/wandb-entrypoint.sh",
"--entrypoint",
"/wandb-entrypoint.sh",
]
if nvidia:
command.extend(["--runtime", "nvidia"])
if not no_dir:
# TODO: We should default to the working directory if defined
command.extend(["-v", cwd + ":" + dir, "-w", dir])
if api.api_key:
command.extend(["-e", f"WANDB_API_KEY={api.api_key}"])
else:
wandb.termlog(
"Couldn't find WANDB_API_KEY, run `wandb login` to enable streaming metrics"
)
if jupyter:
command.extend(["-e", "WANDB_ENSURE_JUPYTER=1", "-p", port + ":8888"])
no_tty = True
cmd = f"jupyter lab --no-browser --ip=0.0.0.0 --allow-root --NotebookApp.token= --notebook-dir {dir}"
command.extend(args)
if no_tty:
command.extend([image, shell, "-c", cmd])
else:
if cmd:
command.extend(["-e", f"WANDB_COMMAND={cmd}"])
command.extend(["-it", image, shell])
wandb.termlog("Launching docker container \U0001f6a2")
subprocess.call(command)
@cli.command(
context_settings=RUN_CONTEXT,
help="Start a local W&B container (deprecated, see wandb server --help)",
hidden=True,
)
@click.pass_context
@click.option("--port", "-p", default="8080", help="The host port to bind W&B local on")
@click.option(
"--env", "-e", default=[], multiple=True, help="Env vars to pass to wandb/local"
)
@click.option(
"--daemon/--no-daemon", default=True, help="Run or don't run in daemon mode"
)
@click.option(
"--upgrade", is_flag=True, default=False, help="Upgrade to the most recent version"
)
@click.option(
"--edge", is_flag=True, default=False, help="Run the bleeding edge", hidden=True
)
@display_error
def local(ctx, *args, **kwargs):
wandb.termwarn("`wandb local` has been replaced with `wandb server start`.")
ctx.invoke(start, *args, **kwargs)
@cli.group(help="Commands for operating a local W&B server")
def server():
pass
@server.command(context_settings=RUN_CONTEXT, help="Start a local W&B server")
@click.pass_context
@click.option(
"--port", "-p", default="8080", help="The host port to bind W&B server on"
)
@click.option(
"--env", "-e", default=[], multiple=True, help="Env vars to pass to wandb/local"
)
@click.option(
"--daemon/--no-daemon", default=True, help="Run or don't run in daemon mode"
)
@click.option(
"--upgrade",
is_flag=True,
default=False,
help="Upgrade to the most recent version",
hidden=True,
)
@click.option(
"--edge", is_flag=True, default=False, help="Run the bleeding edge", hidden=True
)
@display_error
def start(ctx, port, env, daemon, upgrade, edge):
api = InternalApi()
if not _HAS_DOCKER:
raise ClickException("Docker not installed, install it from https://docker.com")
import wandb.docker
local_image_sha = wandb.docker.image_id("wandb/local").split("wandb/local")[-1]
registry_image_sha = wandb.docker.image_id_from_registry("wandb/local").split(
"wandb/local"
)[-1]
if local_image_sha != registry_image_sha:
if upgrade:
subprocess.call(["docker", "pull", "wandb/local"])
else:
wandb.termlog(
"A new version of the W&B server is available, upgrade by calling `wandb server start --upgrade`"
)
running = subprocess.check_output(
["docker", "ps", "--filter", "name=^wandb-local$", "--format", "{{.ID}}"]
)
if running != b"":
if upgrade:
subprocess.call(["docker", "stop", "wandb-local"])
else:
wandb.termerror(
"A container named wandb-local is already running, run `docker stop wandb-local` if you want to start a new instance"
)
exit(1)
image = "docker.pkg.github.com/wandb/core/local" if edge else "wandb/local"
username = getpass.getuser()
env_vars = ["-e", f"LOCAL_USERNAME={username}"]
for e in env:
env_vars.append("-e")
env_vars.append(e)
command = [
"docker",
"run",
"--rm",
"-v",
"wandb:/vol",
"-p",
port + ":8080",
"--name",
"wandb-local",
] + env_vars
host = f"http://localhost:{port}"
api.set_setting("base_url", host, globally=True, persist=True)
if daemon:
command += ["-d"]
command += [image]
# DEVNULL is only in py3
try:
from subprocess import DEVNULL
except ImportError:
DEVNULL = open(os.devnull, "wb") # noqa: N806
code = subprocess.call(command, stdout=DEVNULL)
if daemon:
if code != 0:
wandb.termerror(
"Failed to launch the W&B server container, see the above error."
)
exit(1)
else:
wandb.termlog(f"W&B server started at http://localhost:{port} \U0001f680")
wandb.termlog("You can stop the server by running `wandb server stop`")
if not api.api_key:
# Let the server start before potentially launching a browser
time.sleep(2)
ctx.invoke(login, host=host)
@server.command(context_settings=RUN_CONTEXT, help="Stop a local W&B server")
def stop():
if not _HAS_DOCKER:
raise ClickException("Docker not installed, install it from https://docker.com")
subprocess.call(["docker", "stop", "wandb-local"])
@cli.group(help="Commands for interacting with artifacts")
def artifact():
pass
@artifact.command(context_settings=CONTEXT, help="Upload an artifact to wandb")
@click.argument("path")
@click.option(
"--name", "-n", help="The name of the artifact to push: project/artifact_name"
)
@click.option("--description", "-d", help="A description of this artifact")
@click.option("--type", "-t", default="dataset", help="The type of the artifact")
@click.option(
"--alias",
"-a",
default=["latest"],
multiple=True,
help="An alias to apply to this artifact",
)
@click.option("--id", "run_id", help="The run you want to upload to.")
@click.option(
"--resume",
is_flag=True,
default=None,
help="Resume the last run from your current directory.",
)
@click.option(
"--skip_cache",
is_flag=True,
default=False,
help="Skip caching while uploading artifact files.",
)
@click.option(
"--policy",
default="mutable",
type=click.Choice(["mutable", "immutable"]),
help="Set the storage policy while uploading artifact files.",
)
@display_error
def put(
path,
name,
description,
type,
alias,
run_id,
resume,
skip_cache,
policy,
):
if name is None:
name = os.path.basename(path)
public_api = PublicApi()
entity, project, artifact_name = public_api._parse_artifact_path(name)
if project is None:
project = click.prompt("Enter the name of the project you want to use")
# TODO: settings nightmare...
api = InternalApi()
api.set_setting("entity", entity)
api.set_setting("project", project)
artifact = wandb.Artifact(name=artifact_name, type=type, description=description)
artifact_path = f"{entity}/{project}/{artifact_name}:{alias[0]}"
if os.path.isdir(path):
wandb.termlog(f'Uploading directory {path} to: "{artifact_path}" ({type})')
artifact.add_dir(path, skip_cache=skip_cache, policy=policy)
elif os.path.isfile(path):
wandb.termlog(f'Uploading file {path} to: "{artifact_path}" ({type})')
artifact.add_file(path, skip_cache=skip_cache, policy=policy)
elif "://" in path:
wandb.termlog(
f'Logging reference artifact from {path} to: "{artifact_path}" ({type})'
)
artifact.add_reference(path)
else:
raise ClickException("Path argument must be a file or directory")
with wandb.init(
entity=entity,
project=project,
config={"path": path},
job_type="cli_put",
id=run_id,
resume=resume,
) as run:
run.log_artifact(artifact, aliases=alias)
artifact.wait()
wandb.termlog(
"Artifact uploaded, use this artifact in a run by adding:\n", prefix=False
)
wandb.termlog(
f' artifact = run.use_artifact("{artifact.source_qualified_name}")\n',
prefix=False,
)
@artifact.command(context_settings=CONTEXT, help="Download an artifact from wandb")
@click.argument("path")
@click.option("--root", help="The directory you want to download the artifact to")
@click.option("--type", help="The type of artifact you are downloading")
@display_error
def get(path, root, type):
public_api = PublicApi()
entity, project, artifact_name = public_api._parse_artifact_path(path)
if project is None:
project = click.prompt("Enter the name of the project you want to use")
try:
artifact_parts = artifact_name.split(":")
if len(artifact_parts) > 1:
version = artifact_parts[1]
artifact_name = artifact_parts[0]
else:
version = "latest"
if is_artifact_registry_project(project):
organization = path.split("/")[0] if path.count("/") == 2 else ""
# set entity to match the settings since in above code it was potentially set to an org
settings_entity = public_api.settings["entity"] or public_api.default_entity
# Registry artifacts are under the org entity. Because we offer a shorthand and alias for this path,
# we need to fetch the org entity to for the user behind the scenes.
entity = SDKInternalApi()._resolve_org_entity_name(
entity=settings_entity, organization=organization
)
full_path = f"{entity}/{project}/{artifact_name}:{version}"
wandb.termlog(
"Downloading {type} artifact {full_path}".format(
type=type or "dataset", full_path=full_path
)
)
artifact = public_api.artifact(full_path, type=type)
path = artifact.download(root=root)
wandb.termlog(f"Artifact downloaded to {path}")
except ValueError:
raise ClickException("Unable to download artifact")
@artifact.command(
context_settings=CONTEXT, help="List all artifacts in a wandb project"
)
@click.argument("path")
@click.option("--type", "-t", help="The type of artifacts to list")
@display_error
def ls(path, type):
public_api = PublicApi()
if type is not None:
types = [public_api.artifact_type(type, path)]
else:
types = public_api.artifact_types(path)
for kind in types:
for collection in kind.collections():
versions = public_api.artifact_versions(
kind.type,
"/".join([kind.entity, kind.project, collection.name]),
per_page=1,
)
latest = next(versions)
wandb.termlog(
f"{kind.type:<15s}{latest.updated_at:<15s}{util.to_human_size(latest.size):>15s} {latest.name:<20s}"
)
@artifact.group(help="Commands for interacting with the artifact cache")
def cache():
pass
@cache.command(
context_settings=CONTEXT,
help="Clean up less frequently used files from the artifacts cache",
)
@click.argument("target_size")
@click.option("--remove-temp/--no-remove-temp", default=False, help="Remove temp files")
@display_error
def cleanup(target_size, remove_temp):
target_size = util.from_human_size(target_size)
cache = get_artifact_file_cache()
reclaimed_bytes = cache.cleanup(target_size, remove_temp)
wandb.termlog(f"Reclaimed {util.to_human_size(reclaimed_bytes)} of space")
@cli.command(context_settings=CONTEXT, help="Pull files from Weights & Biases")
@click.argument("run", envvar=env.RUN_ID)
@click.option(
"--project", "-p", envvar=env.PROJECT, help="The project you want to download."
)
@click.option(
"--entity",
"-e",
default="models",
envvar=env.ENTITY,
help="The entity to scope the listing to.",
)
@display_error
def pull(run, project, entity):
api = InternalApi()
project, run = api.parse_slug(run, project=project)
urls = api.download_urls(project, run=run, entity=entity)
if len(urls) == 0:
raise ClickException("Run has no files")
click.echo(f"Downloading: {click.style(project, bold=True)}/{run}")
for name in urls:
if api.file_current(name, urls[name]["md5"]):
click.echo(f"File {name} is up to date")
else:
length, response = api.download_file(urls[name]["url"])
# TODO: I had to add this because some versions in CI broke click.progressbar
sys.stdout.write(f"File {name}\r")
dirname = os.path.dirname(name)
if dirname != "":
filesystem.mkdir_exists_ok(dirname)
with click.progressbar(
length=length,
label=f"File {name}",
fill_char=click.style("&", fg="green"),
) as bar:
with open(name, "wb") as f:
for data in response.iter_content(chunk_size=4096):
f.write(data)
bar.update(len(data))
@cli.command(
context_settings=CONTEXT, help="Restore code, config and docker state for a run"
)
@click.pass_context
@click.argument("run", envvar=env.RUN_ID)
@click.option("--no-git", is_flag=True, default=False, help="Don't restore git state")
@click.option(
"--branch/--no-branch",
default=True,
help="Whether to create a branch or checkout detached",
)
@click.option(
"--project", "-p", envvar=env.PROJECT, help="The project you wish to upload to."
)
@click.option(
"--entity", "-e", envvar=env.ENTITY, help="The entity to scope the listing to."
)
@display_error
def restore(ctx, run, no_git, branch, project, entity):
from wandb.old.core import wandb_dir
api = _get_cling_api()
if ":" in run:
if "/" in run:
entity, rest = run.split("/", 1)
else:
rest = run
project, run = rest.split(":", 1)
elif run.count("/") > 1:
entity, run = run.split("/", 1)
project, run = api.parse_slug(run, project=project)
commit, json_config, patch_content, metadata = api.run_config(
project, run=run, entity=entity
)
repo = metadata.get("git", {}).get("repo")
image = metadata.get("docker")
restore_message = f"""`wandb restore` needs to be run from the same git repository as the original run.
Run `git clone {repo}` and restore from there or pass the --no-git flag."""
if no_git:
commit = None
elif not api.git.enabled:
if repo:
raise ClickException(restore_message)
elif image:
wandb.termlog(
"Original run has no git history. Just restoring config and docker"
)
if commit and api.git.enabled:
wandb.termlog(f"Fetching origin and finding commit: {commit}")
subprocess.check_call(["git", "fetch", "--all"])
try:
api.git.repo.commit(commit)
except ValueError:
wandb.termlog(f"Couldn't find original commit: {commit}")
commit = None
files = api.download_urls(project, run=run, entity=entity)
for filename in files:
if filename.startswith("upstream_diff_") and filename.endswith(
".patch"
):
commit = filename[len("upstream_diff_") : -len(".patch")]
try:
api.git.repo.commit(commit)
except ValueError:
commit = None
else:
break
if commit:
wandb.termlog(f"Falling back to upstream commit: {commit}")
patch_path, _ = api.download_write_file(files[filename])
else:
raise ClickException(restore_message)
else:
if patch_content:
patch_path = os.path.join(wandb_dir(), "diff.patch")
with open(patch_path, "w") as f:
f.write(patch_content)
else:
patch_path = None
branch_name = f"wandb/{run}"
if branch and branch_name not in api.git.repo.branches:
api.git.repo.git.checkout(commit, b=branch_name)
wandb.termlog(f"Created branch {click.style(branch_name, bold=True)}")
elif branch:
wandb.termlog(
f"Using existing branch, run `git branch -D {branch_name}` from master for a clean checkout"
)
api.git.repo.git.checkout(branch_name)
else:
wandb.termlog(f"Checking out {commit} in detached mode")
api.git.repo.git.checkout(commit)
if patch_path:
# we apply the patch from the repository root so git doesn't exclude
# things outside the current directory
root = api.git.root
patch_rel_path = os.path.relpath(patch_path, start=root)
# --reject is necessary or else this fails any time a binary file
# occurs in the diff
exit_code = subprocess.call(
["git", "apply", "--reject", patch_rel_path], cwd=root
)
if exit_code == 0:
wandb.termlog("Applied patch")
else:
wandb.termerror(
"Failed to apply patch, try un-staging any un-committed changes"
)
filesystem.mkdir_exists_ok(wandb_dir())
config_path = os.path.join(wandb_dir(), "config.yaml")
config = Config()
for k, v in json_config.items():
if k not in ("_wandb", "wandb_version"):
config[k] = v
s = b"wandb_version: 1"
s += b"\n\n" + yaml.dump(
config._as_dict(),
Dumper=yaml.SafeDumper,
default_flow_style=False,
allow_unicode=True,
encoding="utf-8",
)
s = s.decode("utf-8")
with open(config_path, "w") as f:
f.write(s)
wandb.termlog(f"Restored config variables to {config_path}")
if image:
if not metadata["program"].startswith("<") and metadata.get("args") is not None:
# TODO: we may not want to default to python here.
runner = util.find_runner(metadata["program"]) or ["python"]
command = runner + [metadata["program"]] + metadata["args"]
cmd = " ".join(command)
else:
wandb.termlog("Couldn't find original command, just restoring environment")
cmd = None
wandb.termlog("Docker image found, attempting to start")
ctx.invoke(docker, docker_run_args=[image], cmd=cmd)
return commit, json_config, patch_content, repo, metadata
@cli.command("online", help="Enable W&B sync")
@display_error
def online():
api = InternalApi()
try:
api.clear_setting("mode", persist=True)
except configparser.Error:
pass
click.echo(
"W&B online. Running your script from this directory will now sync to the cloud."
)
@cli.command("offline", help="Disable W&B sync")
@display_error
def offline():
api = InternalApi()
try:
api.set_setting("mode", "offline", persist=True)
click.echo(
"W&B offline. Running your script from this directory will only write metadata locally. Use wandb disabled to completely turn off W&B."
)
except configparser.Error:
click.echo(
"Unable to write config, copy and paste the following in your terminal to turn off W&B:\nexport WANDB_MODE=offline"
)
@cli.command("on", hidden=True)
@click.pass_context
@display_error
def on(ctx):
ctx.invoke(online)
@cli.command("off", hidden=True)
@click.pass_context
@display_error
def off(ctx):
ctx.invoke(offline)
@cli.command("status", help="Show configuration settings")
@click.option(
"--settings/--no-settings", help="Show the current settings", default=True
)
def status(settings):
api = _get_cling_api()
if settings:
click.echo(click.style("Current Settings", bold=True))
settings = api.settings()
click.echo(
json.dumps(settings, sort_keys=True, indent=2, separators=(",", ": "))
)
@cli.command("disabled", help="Disable W&B.")
@click.option(
"--service",
is_flag=True,
show_default=True,
default=True,
help="Disable W&B service",
)
def disabled(service):
api = InternalApi()
try:
api.set_setting("mode", "disabled", persist=True)
click.echo("W&B disabled.")
except configparser.Error:
click.echo(
"Unable to write config, copy and paste the following in your terminal to turn off W&B:\nexport WANDB_MODE=disabled"
)
@cli.command("enabled", help="Enable W&B.")
@click.option(
"--service",
is_flag=True,
show_default=True,
default=True,
help="Enable W&B service",
)
def enabled(service):
api = InternalApi()
try:
api.set_setting("mode", "online", persist=True)
click.echo("W&B enabled.")
except configparser.Error:
click.echo(
"Unable to write config, copy and paste the following in your terminal to turn on W&B:\nexport WANDB_MODE=online"
)
@cli.command(context_settings=CONTEXT, help="Verify your local instance")
@click.option("--host", default=None, help="Test a specific instance of W&B")
def verify(host):
# TODO: (kdg) Build this all into a WandbVerify object, and clean this up.
os.environ["WANDB_SILENT"] = "true"
os.environ["WANDB_PROJECT"] = "verify"
api = _get_cling_api()
reinit = False
if host is None:
host = api.settings("base_url")
wandb.termlog(f"Default host selected: {host}")
# if the given host does not match the default host, re-run init
elif host != api.settings("base_url"):
reinit = True
tmp_dir = tempfile.mkdtemp()
wandb.termlog(
"Find detailed logs for this test at: {}".format(os.path.join(tmp_dir, "wandb"))
)
os.chdir(tmp_dir)
os.environ["WANDB_BASE_URL"] = host
wandb.login(host=host)
if reinit:
api = _get_cling_api(reset=True)
if not wandb_verify.check_host(host):
sys.exit(1)
if not wandb_verify.check_logged_in(api, host):
sys.exit(1)
url_success, url = wandb_verify.check_graphql_put(api, host)
large_post_success = wandb_verify.check_large_post()
wandb_verify.check_secure_requests(
api.settings("base_url"),
"Checking requests to base url",
"Connections are not made over https. SSL required for secure communications.",
)
if url:
wandb_verify.check_secure_requests(
url,
"Checking requests made over signed URLs",
"Signed URL requests not made over https. SSL is required for secure communications.",
)
wandb_verify.check_cors_configuration(url, host)
wandb_verify.check_wandb_version(api)
check_run_success = wandb_verify.check_run(api)
check_artifacts_success = wandb_verify.check_artifacts()
check_sweeps_success = wandb_verify.check_sweeps(api)
if not (
check_artifacts_success
and check_run_success
and large_post_success
and url_success
and check_sweeps_success
):
sys.exit(1)
cli.add_command(beta)
|