question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Streamline contributing experience

See original GitHub issue

Related to #5167.


The largest part of our contribution guidelines explain contributors how to work on torchvision. Due to sheer amount of techniques and tools that can be quite overwhelming for a new contributor.

I’m going to use $TOOL as a placeholder for what I imagine:

  • $TOOL install: Installs torch from nightlies and builds torchvision in the current environment
  • $TOOL format: Runs autoformatters
  • $TOOL lint: Runs linters
  • $TOOL test: Runs tests
  • $TOOL docs: Builds documentation

There are a couple of tools out there that do this. Of the top of my head we could use pydoit, tox, or simply make. AFAIK, all of them allow parametrization of the top-level commands so we can provide sensible default while not losing flexibility. For example, $TOOL test will run all tests by default, but dispatches additional arguments directly to pytest.

I can do more in depth research about the tools and which would be the best fit for us if we see this proposal as net-benefit in general.

Issue Analytics

  • State:open
  • Created 2 years ago
  • Reactions:1
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

2reactions
datumboxcommented, Jan 7, 2022

Abstracting these details away from contributors might lead to less understanding of how pieces fit together. Perhaps improving our contribution guidelines documentation can make things clearer while not requiring users to use a specific tool that hides the details away. Thoughts?

0reactions
pmeiercommented, Jan 7, 2022

Maybe, a bash/bat scripts could be sufficient instead of writing machinery with pydoit or others similar.

We would only have to parametrize the tools whereas we would need to implement the scripts ourselves. Plus, I see two more downsides:

  1. Instead of having one config, we would effectively need to maintain 2 scripts
  2. My bash and bat scripting experience is minimal and practically non-existent, respectively. The tools that I mentioned are declaritive, so they should be a lot easier to pick up.
Read more comments on GitHub >

github_iconTop Results From Across the Web

How to streamline your customer experience and get repeat ...
Ask for Feedback and Use it. You can learn more from your customer than you might think, you can ask them what they...
Read more >
6 Ways To Streamline Business Processes and Workflows
1. Assess existing processes and workflows · 2. Rank processes · 3. Analyze outcomes · 4. Ask for feedback · 5. Streamline and...
Read more >
​3 ways to streamline the customer experience - The ...
​3 ways to streamline the customer experience ... Contributing Writer, ... Customer experience (which includes customer engagement and ...
Read more >
4 tips to streamline content creation in Oracle Content ...
Work with them to validate the contribution experience as you design your content model. Focus on the content they'll have to create most ......
Read more >
How to Streamline Your Work Processes | Smartsheet
Let's go back to the process of invoicing clients. Documenting this process may be the first step in identifying the activities that contribute...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found