chore(sdk): adding back the required flag for wandb-core

.circleci/config.yml

@@ -416,6 +416,9 @@ jobs:
 
     executor: <<parameters.executor>>
 
+    environment:
+      WANDB__REQUIRE_CORE: <<parameters.with_core>>
+
     # Shards the job, setting $CIRCLE_NODE_TOTAL and $CIRCLE_NODE_INDEX.
     # https://circleci.com/docs/parallelism-faster-jobs/
     parallelism: 2
@@ -489,6 +492,9 @@ jobs:
 
     executor: <<parameters.executor>>
 
+    environment:
+      WANDB__REQUIRE_CORE: <<parameters.with_core>>
+
     parallelism: 4
 
     steps:
@@ -624,6 +630,7 @@ jobs:
     environment:
       SHARD: << parameters.shard >>
       COVERAGE_DIR: << parameters.coverage_dir >>
+      WANDB__REQUIRE_CORE: << parameters.with_core >>
     parallelism: << parameters.parallelism >>
     resource_class: xlarge
     working_directory: /mnt/ramdisk

core/README.md

@@ -17,6 +17,14 @@ the package in your environment. The `wandb` library will automatically detect a
 pip install -U wandb wandb-core
 ```
 
+in the top of your script add the following:
+
+```python
+import wandb
+
+wandb.require("core")
+```
+
 Note: ensure you have `wandb>=0.16.4`.
 
 ### Platform Compatibility
@@ -42,6 +50,8 @@ To revert to the old SDK backend, simply uninstall `wandb-core` from your enviro
 pip uninstall wandb-core
 ```
 
+or remove the `wandb.require("core")` from your script.
+
 ## Contributing
 
 Your contributions are welcome! Check our [contributing guide](docs/contributing.md) for instructions on setting up your development environment and contributing to the project.

tox.ini

@@ -113,6 +113,7 @@ passenv=
     CI_PYTEST_PARALLEL
     CI
     importer-wandb: WANDB_TEST_SERVER_URL2
+    WANDB__REQUIRE_CORE
 allowlist_externals=
     mkdir
     nox
@@ -155,6 +156,7 @@ passenv=
     SHARD
     WANDB_API_KEY
     core: GOCOVERDIR
+    WANDB__REQUIRE_CORE
 allowlist_externals=
     mkdir
     core: nox
@@ -186,6 +188,7 @@ passenv=
 ;    llm: WANDB_API_KEY
     llm: OPENAI_API_KEY
     llm: CO_API_KEY
+    WANDB__REQUIRE_CORE
 allowlist_externals=
     mkdir
 commands_pre=
@@ -208,6 +211,7 @@ passenv=
     USERNAME
     WANDB_API_KEY
     SHARD
+    WANDB__REQUIRE_CORE
 deps=
     yea-wandb=={env:YEA_WANDB_VERSION}
     wheel

wandb/env.py

@@ -87,6 +87,7 @@
 LAUNCH_QUEUE_NAME = "WANDB_LAUNCH_QUEUE_NAME"
 LAUNCH_QUEUE_ENTITY = "WANDB_LAUNCH_QUEUE_ENTITY"
 LAUNCH_TRACE_ID = "WANDB_LAUNCH_TRACE_ID"
+_REQUIRE_CORE = "WANDB__REQUIRE_CORE"
 
 # For testing, to be removed in future version
 USE_V1_ARTIFACTS = "_WANDB_USE_V1_ARTIFACTS"
@@ -146,6 +147,10 @@ def _env_as_bool(
     return val if isinstance(val, bool) else False
 
 
+def is_require_core(env: Optional[Env] = None) -> bool:
+    return _env_as_bool(_REQUIRE_CORE, default="False", env=env)
+
+
 def is_debug(default: Optional[str] = None, env: Optional[Env] = None) -> bool:
     return _env_as_bool(DEBUG, default=default, env=env)