add backticks around regex examples in docstrings

[axl1313]

Description

The build for help.cleanlab.ai is currently broken since there are some places in the docstrings for the data enrichment utils that contain unescaped angled brackets (<>). Since docusaurus converts pages to HTML, these are interpreted as unclosed JSX tags. Adding backticks around these fixes the build issue (and also makes the formatting for these regex examples nicer imo).

How to test

• Checkout this branch of cleanlab-studio
• Run pip install -Ue .
• Inside of cleanlab-studio-docs, run make update-notebooks && make update-api-reference && make docs. Check that building docs succeeds. Navigate to localhost:3000 and check that API reference docs for data enrichment utils look correct.

[jwmueller]

@axl1313 Thanks for fixing sorry about breaking it under a tight deadline!

Actually we don't want any of this new code to show up in the docs on help.cleanlab.ai yet, it's not ready for public consumption, only select customers where our team is available to support them. Could you help us ensure it's not going to show up on help.cleanlab.ai documentation for now?

I verified the docs for this didnt show up and thought we were good, but seems like that's just cause the build was broken...

[jwmueller]

@axl1313 Also would be good to know how you determine the help.cleanlab.ai build is broken, if you can add all of ML team to that notification system, as well as Matt Turk. Thanks!

[axl1313]

@axl1313 Thanks for fixing sorry about breaking it under a tight deadline!

Actually we don't want any of this new code to show up in the docs on help.cleanlab.ai yet, it's not ready for public consumption, only select customers where our team is available to support them. Could you help us ensure it's not going to show up on help.cleanlab.ai documentation for now?

I verified the docs for this didnt show up and thought we were good, but seems like that's just cause the build was broken...

Ah okay. Currently, we automatically add documentation for everything inside of the studio and utils modules to help.cleanlab.ai. I can put up a quick PR in the docs repo to make it so that we have to explicitly add submodules within utils to the generated API reference instead of including everything inside of utils.

[axl1313]

@axl1313 Thanks for fixing sorry about breaking it under a tight deadline!
Actually we don't want any of this new code to show up in the docs on help.cleanlab.ai yet, it's not ready for public consumption, only select customers where our team is available to support them. Could you help us ensure it's not going to show up on help.cleanlab.ai documentation for now?
I verified the docs for this didnt show up and thought we were good, but seems like that's just cause the build was broken...

Ah okay. Currently, we automatically add documentation for everything inside of the studio and utils modules to help.cleanlab.ai. I can put up a quick PR in the docs repo to make it so that we have to explicitly add submodules within utils to the generated API reference instead of including everything inside of utils.

PR up here https://github.com/cleanlab/cleanlab-studio-docs/pull/462

[axl1313]

@axl1313 Also would be good to know how you determine the help.cleanlab.ai build is broken, if you can add all of ML team to that notification system, as well as Matt Turk. Thanks!

I get notifications when the "Build and Deploy Docs" Github action fails for deployments that are triggered from a new release of cleanlab-studio (the action is triggered using my credentials). I can't immediately think of/find a quick way to set it up to notify multiple people, but I can create a ticket to make this possible.

[jwmueller]

@axl1313 Also would be good to know how you determine the help.cleanlab.ai build is broken, if you can add all of ML team to that notification system, as well as Matt Turk. Thanks!

I get notifications when the "Build and Deploy Docs" Github action fails for deployments that are triggered from a new release of cleanlab-studio (the action is triggered using my credentials). I can't immediately think of/find a quick way to set it up to notify multiple people, but I can create a ticket to make this possible.

ah no worries then, probably not worth actual work investment right now

[ulya-tkch]

Built locally and confirmed docs do not show up on website.